Connector API

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, job polling, status, and balance endpoints return JSON with content-type: application/json. Successful invoke and job responses return the connector data payload directly; its raw field contains the upstream API payload returned for that connector call.

Catalog and describe endpoints return JSON by default. Their format=markdown variants are compatibility views for browser/docs usage only; the CLI consumes JSON and renders any pretty terminal output locally.

The CLI wraps these HTTP payloads as { "status": <http_status>, "data": <payload> } before printing to stdout. When a business error occurs, invoke and job responses still return JSON and include x-error-code for machine-readable branching.