import

Propose how CSV, Markdown or a Symbol export would import, without writing

Changed on
post/api/preview/import/analyze

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization codehttps://mcp.symbol.chat/authorize
      Token URLhttps://mcp.symbol.chat/token

Request body

format'csv' | 'markdown' | 'symbol' required
import_run_idstring

For a Symbol export: the run an earlier analysis returned. When that run exists for the caller, analyze renews it, returning the same type_slugs with a fresh type_slugs_sig; otherwise it starts a run with this id. Omitted, the run is derived from the export, so analyzing the same export into the same place again renews its run; send a new id to import the export again as a separate copy.

target_type_idstring

Import into this existing Type; the proposed mapping matches its fields.

workspace_idstring nullable

UUID v4 string

Response

Successful response

format'csv' | 'markdown' | 'symbol' required
import_run_idstring

For a Symbol export: the run its import calls belong to. Keep it with each call's import_key, pass it on every execute call of the run, and send it to analyze again to renew an expired type_slugs_sig.

import_runs_remaininginteger required

Import calls the caller has left this hour. Each call imports up to 1,000 rows; a client splitting a larger import checks this first.

requires_reviewboolean
row_countinteger required
type_slugsobject

For a Symbol export: the slug each of its Types takes in the destination. Pass it, with type_slugs_sig, unchanged on every import call of the run.

type_slugs_sigstring

Server signature over type_slugs, valid for 24 hours; pass it unchanged.

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      the response's property pattern was changed from ^(?:v1\.\d{1,12}\.[0-9a-f]{64}|v2\.\d{1,12}\.[0-9a-f]{32}\.[0-9a-f]{64})$ to ^(?:v1\.\d{1,12}\.[0-9a-f]{64}|v[23]\.\d{1,12}\.[0-9a-f]{32}\.[0-9a-f]{64})$ for the status

    • info

      added the optional property to the response with the status

    • info

      the response's property pattern was changed from ^v1\.\d{1,12}\.[0-9a-f]{64}$ to ^(?:v1\.\d{1,12}\.[0-9a-f]{64}|v2\.\d{1,12}\.[0-9a-f]{32}\.[0-9a-f]{64})$ for the status