Connector API

HTTP endpoints for listing, describing, invoking, and polling connector jobs.

Authentication

Connector API requests use the same API key table as the rest of the product.

  • Authorization: Bearer <api_key>
  • x-api-key: <api_key>

Endpoints

  • GET /api/connectors
  • GET /api/connectors?format=markdown
  • GET /api/connectors/[connectorId]
  • GET /api/connectors/[connectorId]?format=markdown
  • POST /api/connectors/[connectorId]/invoke
  • GET /api/connectors/jobs/[jobId]
  • GET /api/connectors/status
  • GET /api/connectors/balance (compatibility alias)

Output contract

Connector invocation and CLI-oriented list/describe/status endpoints return Markdown with content-type: text/markdown.

When a business error occurs, the response still returns Markdown and includes x-error-code for machine-readable branching.