SYsymbol-chat
import

Import CSV, Markdown or a Symbol export as typed capsules

Changed on
post/api/preview/import

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

Query parameters

wsstring

Optional workspace context for the request. Same value rules as the MCP workspace tool argument. Omit to use the caller's default workspace.

Request body

format'csv' | 'markdown' | 'symbol' required
import_keystring

This import's identity. Omit it and the server derives one from the exact request; the response always returns the key used. Send the same key to retry, including with failed rows corrected, and a new key to import the same rows again on purpose.

import_run_idstring

For a Symbol export: the import_run_id analyze returned, sent on every call of the run. With type_slugs_sig it must be the run the signature names. A one-Type export imported without type_slugs joins the run this names, or, when it is omitted, the run analyze would derive for the export (a run of its own when create_type.slug differs from the export's slug for that Type), so the same export imported again is recognized. To import an export again as a separate copy, send a new import_run_id and a new import_key.

mark_incompleteboolean

Import rows that are missing required field values as incomplete capsules instead of skipping them.

source_type_slugstring

For a Symbol export carrying several Types: which of its Types this call imports.

target_type_idstring

Import into this existing Type.

type_slugsobject

For a Symbol export: the type_slugs analyze returned, passed unchanged on every call of the run (with type_slugs_sig). Required for an export whose manifest names several Types.

type_slugs_sigstring

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

workspace_idstring nullable

UUID v4 string

Response

Successful response

createdinteger required
import_keystring

The key this call ran under: the request's import_key, or the one derived from the request. Send it again to retry.

import_run_idstring

The run a Symbol export's import calls belong to, returned by analyze. Send it to analyze again to renew an expired type_slugs_sig for the same run, and on every execute call of the run.

warningsstring[] required

Non-blocking notes, such as a reference between imported capsules that could not be rewritten.

Changes

  • 24536ef7ac40Revision changes
    • warning

      changed the pattern of the request property 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})$

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • fd7b0a7085e4Revision changes
    • warning

      changed the pattern of the request property 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})$

    • info

      added the new optional query request parameter ws

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the success response with the status