API Reference

Mint a Saffron connect session (cardamom / catalog)

POST /api/connectors/{id}/connect-session

Cardamom / catalog connectors only. Uses the deploy's SAFFRON_API_TOKEN (sfk_…) against Saffron /v1. Ensures the installed integration exists, refreshes the environment redirect allow-list, and returns a connect_url. Returns 400 BYOA_REQUIRED when the catalog OAuth client.id is dummy and no customer OAuth app has been configured yet.

Operation IDcreateConnectorConnectSession

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

Content typeapplication/json

requestobject

5 properties

integration_slugstring

Catalog slug to connect (falls back to connector config.integration)

tenant_idstring

environment_idstring

Ignored for /v1 (taken from the sfk_ token scope)

redirect_uristring

reconnect_account_idstring

Success response body

200Connect session minted

Connect session minted

Content typeapplication/json

responseobject

2 properties

connect_sessionstringrequired

connect_urlstring · urirequired

Error responses

400Not a cardamom connector, BYOA required, or invalid body

Not a cardamom connector, BYOA required, or invalid body

No response content schema is documented.

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

500Connect session mint failed

Connect session mint failed

No response content schema is documented.

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/connectors/YOUR_ID/connect-session' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "integration_slug": "string",
  "tenant_id": "string",
  "environment_id": "string",
  "redirect_uri": "string",
  "reconnect_account_id": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/connectors/YOUR_ID/connect-session", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "integration_slug": "string",
    "tenant_id": "string",
    "environment_id": "string",
    "redirect_uri": "string",
    "reconnect_account_id": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);