K-φ (K-Phi) Sheet Register API

openapi: 3.2.0
info:
  title: K-φ Sheet Register API
  version: 1.0.0
  description: 'Read your K-φ data (statements, cash, forecasts, scenarios) and save scenarios. The tenant always comes from the credential. Every response is { data, meta }; every error { error: { code, message } }.'
tags:
- name: Sheet Register
paths:
  /api/v1/sheet_register:
    post:
      operationId: post_sheet_register
      summary: Register a Google Sheet as an API
      x-audience: data
      description: 'Register a Google Sheet as an input of this account: K-φ reads every tab (or the ones named) and serves each as JSON at /api/v1/sheets/{id}/{tab}. The sheet must be shared "Anyone with the link" (Viewer), or with K-φ''s service address when one is set up. Read only: K-φ never writes to the sheet. Registering the same sheet again reads it again and updates the name and tabs kept. auto_sync: true (needs write:data too) loads the sheet''s contract tabs (BAL, TRA, INV, MAP, FX) into K-φ each time it is found changed, as kphi_sheet_sync does.'
      x-scope: write:sheets
      x-extension-only: false
      security:
      - bearer: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                  meta:
                    type: object
                    properties:
                      api:
                        type: string
                      capability:
                        type: string
                      at:
                        type: string
        '401':
          description: No or invalid credential
        '403':
          description: Scope, extension or Builder Mode refused
        '422':
          description: The capability refused the input
        '429':
          description: Rate or daily quota reached
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The Google Sheets link (or the spreadsheet id)
                name:
                  type: string
                  description: 'A name for it in K-φ (default: the first tab''s name and the id)'
                tabs:
                  type: array
                  items:
                    type: string
                  description: 'The tabs to serve (default: all)'
                auto_sync:
                  type: boolean
                  description: Sync the contract tabs into K-φ each time the sheet changes (default false; needs write:data)
                mapping:
                  type: object
                  description: 'Per tab, what it becomes when its name or columns do not say: { "<tab>": { object: "TRA", fields: { amount: { from: "Montant", as: "number" }, currency: { const: "EUR" } } } }; object "api" serves the tab without loading it'
                  additionalProperties: true
              required:
              - url
              additionalProperties: false
      tags:
      - Sheet Register
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: API key, OAuth access token, extension key (kphix_…) or extension session token (kxs1.…)
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with the gl:ingest scope (ERP connectors)
x-scopes:
  gl:ingest: Push GL data from an ERP (/api/gl/mappings, /api/gl/schema, /api/gl/ingest)
  mcp:tools: All read scopes (read:gl read:cash read:forecast read:sheets read:data)
  mcp:write: All MCP write scopes (write:scenarios write:config write:data write:sheets)
  read:gl: Read statements, KPIs, ratios, GL lines, versions, dimensions, variance, data lake, FX rates and FP&A settings
  read:cash: Read bank positions, transactions, balance history, cash forecast, AR/AP
  read:forecast: Read forecasts, budgets, scenarios (levers, list, run) and valuations
  read:sheets: Read the Google Sheets registered as inputs of the account, each tab as JSON (/api/v1/sheets/…), and their webhooks' deliveries (2026-11-02)
  write:sheets: 'Register and remove the Google Sheets the account serves as JSON (read only: K-φ never writes to a sheet), and the webhooks told when one changes'
  read:data: 'Read the Data library (/api/v1/data/…): market, macro and public series with their source and licence (2026-11-03)'
  write:vars: 'Define, load and remove the account''s own variables (var.<CODE>) of the Data library, and nothing else: never the books (2026-11-05)'
  write:scenarios: Save scenarios (Simulation page)
  write:config: 'Change tenant configuration: flow rules, classification overrides, budget versions and templates, valuation refresh'
  write:data: 'Import rows from a spreadsheet Claude read (Excel in, 2026-10-29): cash forecasts, a GL version, a bank statement; preview first, then commit'
  run:build: 'Call the BUILD''s functions that only read (POST /api/v1/fn/<name>): the logic the account built, served as an API (2026-10-29)'
  run:build:write: 'Also call the BUILD''s functions that change data (declared "writes": true in its kphi.json)'
x-limits:
  per_ip_per_min: 200
  extension_per_min: 120
  extension_per_day: 20000