connect
Public integration catalog and tenant developer-onboarding state.
| Method | Path | Operation ID |
|---|---|---|
| GET | /v1/connect-catalog |
getConnectCatalog |
| GET | /v1/developer-onboarding |
getDeveloperOnboarding |
GET /v1/connect-catalog
Section titled “GET /v1/connect-catalog”Operation ID: getConnectCatalog
Read the public versioned Connect catalog for human and prompt renderers.
Authentication: none (anonymous).
Responses
Section titled “Responses”| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | application/json ConnectCatalogResponse |
200 response fields
Section titled “200 response fields”| Field | Type | Required | Description |
|---|---|---|---|
ai_actions |
array of AiActionResponse | yes | |
ai_prompt |
AiPromptResponse | yes | |
api_reference_url |
string | yes | |
authorization_header |
string | yes | |
canonical_calls |
array of CanonicalCallResponse | yes | |
clients |
array of ConnectClientResponse | yes | |
common_errors |
array of CommonErrorMeaningResponse | yes | |
connection_modes |
array of ConnectModeResponse | yes | |
documentation_url |
string | yes | |
environment_variables |
array of ConnectEnvironmentVariableResponse | yes | |
limits_and_cost |
LimitsCostGuidanceResponse | yes | |
mcp_clients |
array of McpClientResponse | yes | |
mcp_feature_groups |
array of McpFeatureGroupResponse | yes | |
processing_modes |
array of string | yes | |
public_api_origin |
string | yes | |
safety |
array of SafetyStatementResponse | yes | |
templates |
array of ConnectTemplateResponse | yes | |
version |
string | yes |
GET /v1/developer-onboarding
Section titled “GET /v1/developer-onboarding”Operation ID: getDeveloperOnboarding
Read secret-free tenant setup and API-key request-observation state.
Authentication: Authorization: Bearer <API key or console session> (Authentication).
Responses
Section titled “Responses”| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | application/json DeveloperOnboardingResponse |
| 401 | The bearer credential is missing, malformed, expired, revoked, or otherwise invalid. Clerk sessions and scoped API keys fail identically and the body never reveals which credential was presented or whether it exists. | application/json HttpErrorResponse |
| 403 | The provider deleted this identity, or the account is deactivated. A valid session cannot authorize a tombstoned identity back into use; an API key must also grant the scope required by the operation, and an operation is not classified by the route/scope policy and is denied by default. An API key restricted to client networks is refused from any other network with the API_KEY_IP_NOT_ALLOWED envelope. |
application/json HttpErrorResponse or ErrorResponse |
| 409 | Just-in-time provisioning conflicted: the verified email belongs to another provisioned account. | application/json HttpErrorResponse |
| 422 | A verified email is unavailable for account provisioning. | application/json HttpErrorResponse |
| 429 | The API key’s own request rate limit was exceeded (API_KEY_RATE_LIMITED). Only keys configured with a rate limit can receive this. Retryable after Retry-After seconds; the refused request consumed no capacity. |
application/json ErrorResponse |
| 503 | Credential verification is unavailable: Clerk session verification is not configured, no API-key pepper is enrolled, or bounded API-key verification is temporarily overloaded. Retryable. | application/json HttpErrorResponse |
200 response fields
Section titled “200 response fields”| Field | Type | Required | Description |
|---|---|---|---|
api_keys |
OnboardingApiKeysResponse | yes |