Loading API reference…
/organizations/{organizationId}/integrationsuuidOpaque alphabetical pagination cursor.
1 <= value <= 20020application/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations"{ "success": true, "statusCode": 0, "message": "string", "data": [ { "readiness": "ready", "settings": { "kind": "upstash", "restUrl": "http://example.com", "keyScope": { "kind": "prefixes", "prefixes": [ "string" ] } } } ], "meta": {}, "pagination": {}}/organizations/{organizationId}/integrationsuuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations" \ -H "Content-Type: application/json" \ -d '{}'/organizations/{organizationId}/integrations/{integrationRef}uuidapplication/json
curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string"{ "success": true, "statusCode": 0, "message": "string", "data": { "readiness": "ready", "settings": { "kind": "upstash", "restUrl": "http://example.com", "keyScope": { "kind": "prefixes", "prefixes": [ "string" ] } } }, "meta": {}}/organizations/{organizationId}/integrations/{integrationRef}uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X PATCH "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string" \ -H "Content-Type: application/json" \ -d '{}'/organizations/{organizationId}/integrations/{integrationRef}uuidcurl -X DELETE "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string"/organizations/{organizationId}/integrations/{integrationRef}/google-analytics/propertiesReturns bounded, non-secret property options used to configure the Google Analytics integration. A Google Analytics credential must already be connected.
uuidcurl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/google-analytics/properties"/organizations/{organizationId}/integrations/{integrationRef}/lemon-squeezy/storesUses the optional write-only API key, or the integration's stored credential when omitted. Returns at most 200 non-secret store options without persisting the supplied key or discovery response.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/lemon-squeezy/stores" \ -H "Content-Type: application/json" \ -d '{}'{ "success": true, "statusCode": 0, "message": "string", "data": { "items": [ { "id": "string", "name": "string", "slug": "string", "domain": "string", "currency": "string" } ], "truncated": true }, "meta": {}}/organizations/{organizationId}/integrations/{integrationRef}/mongodb/resourcesUses supplied structured Atlas credentials, or the integration's stored credential when omitted. Returns collection and sampled dotted-field names only; document values are never returned and no setup state is persisted.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/mongodb/resources" \ -H "Content-Type: application/json" \ -d '{ "databaseName": "string" }'/organizations/{organizationId}/integrations/{integrationRef}/credentialuuidcurl -X DELETE "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/credential"/organizations/{organizationId}/integrations/{integrationRef}/credentialuuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/credential" \ -H "Content-Type: application/json" \ -d '{}'/organizations/{organizationId}/integrations/{integrationRef}/settingsValidates provider-specific resource boundaries and rediscovery before atomically updating settings.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/settings" \ -H "Content-Type: application/json" \ -d '{ "settings": { "kind": "upstash", "restUrl": "http://example.com", "keyScope": { "kind": "prefixes", "prefixes": [ "string" ] } } }'/organizations/{organizationId}/integrations/{integrationRef}/oauth/google/startStarts a runtime-bound Google authorization. Workspace requires selected services and an access mode; Google Analytics uses its fixed read-only scope and accepts an empty body.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/oauth/google/start" \ -H "Content-Type: application/json" \ -d '{ "accessMode": "read_only", "enabledTools": [ "gmail" ] }'/organizations/{organizationId}/integrations/{integrationRef}/oauth/mcp/startStarts provider authorization with the runtime's reviewed dynamic-registration or deployment-client policy. Deployment client IDs are backend configuration and are never accepted from this request.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/oauth/mcp/start" \ -H "Content-Type: application/json" \ -d '{ "accessMode": "read_only" }'/oauth/google/callbackOAuth state for OAuth 2.0 providers. OAuth 1.0a providers return oauth_token instead.
curl -X GET "https://example.com/oauth/google/callback"curl -X GET "https://example.com/oauth/mcp/callback?state=string"/organizations/{organizationId}/integrations/{integrationRef}/discoveruuidcurl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/discover"/organizations/{organizationId}/integrations/{integrationRef}/statusuuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X PATCH "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/status" \ -H "Content-Type: application/json" \ -d '{}'/organizations/{organizationId}/integrations/{integrationRef}/toolsuuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
An explicit tool list wins. Supplying only accessMode selects every tool currently eligible for that mode.
An explicit tool list wins. Supplying only accessMode selects every tool currently eligible for that mode.
curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/tools" \ -H "Content-Type: application/json" \ -d '{ "accessMode": "read_only" }'/organizations/{organizationId}/integrations/{integrationRef}/context-mappingQueues a bounded Operator repair from partial business hints. It never edits canonical Context synchronously and does not affect connection success.
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
Partial business-context hints. At least one department, business function, task pattern, workflow key, or role is required.
curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/context-mapping" \ -H "Content-Type: application/json" \ -d '{ "departments": [ "growth" ], "businessFunctions": [ "Outbound prospecting" ], "workflowKeys": [ "qualified-lead-research" ], "role": "primary" }'/internal/agent/organizations/{organizationId}/integrationsReturns control-plane readiness, enabled capabilities, access mode, department tags, and profile availability. It never returns credentials, provider endpoints, OAuth subjects, or live provider health.
Token used by trusted agent runtimes.
In: header
uuidcurl -X GET "https://example.com/internal/agent/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations?authorizationEpoch=1"/internal/agent/organizations/{organizationId}/integrations/{integrationKey}Reads the authorization-fenced safe registry snapshot without contacting the provider.
Token used by trusted agent runtimes.
In: header
uuid^[a-z0-9]+(?:-[a-z0-9]+)*$curl -X GET "https://example.com/internal/agent/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string?authorizationEpoch=1"/internal/agent/organizations/{organizationId}/integrations/resolveagentServiceToken Token used by trusted agent runtimes.
In: header
uuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/internal/agent/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/resolve" \ -H "Content-Type: application/json" \ -d '{}'/internal/git/integrations/{integrationId}/{owner}/{repository}/info/refsProxies Git smart-HTTP discovery to the fixed GitHub origin. Upload-pack is available to granted non-verification Engineering task runs; receive-pack additionally requires execute mode and full integration access.
integrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuid^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$^[A-Za-z0-9_.-]{1,100}$Value in
curl -X GET "https://example.com/internal/git/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/string/string/info/refs?service=git-upload-pack""string"/internal/git/integrations/{integrationId}/{owner}/{repository}/git-upload-packintegrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuid^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$^[A-Za-z0-9_.-]{1,100}$application/x-git-upload-pack-request
TypeScript Definitions
Use the request body type in TypeScript.
binaryapplication/x-git-upload-pack-result
curl -X POST "https://example.com/internal/git/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/string/string/git-upload-pack" \ -H "Content-Type: application/x-git-upload-pack-request" \ -d 'string'"string"/internal/git/integrations/{integrationId}/{owner}/{repository}/git-receive-packValidates and privately stages a bounded receive-pack, then routes the branch update through the typed action lifecycle. Tags, deletions, push options, and more than 20 ref updates are rejected.
integrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuid^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$^[A-Za-z0-9_.-]{1,100}$application/x-git-receive-pack-request
TypeScript Definitions
Use the request body type in TypeScript.
binaryapplication/x-git-receive-pack-result
curl -X POST "https://example.com/internal/git/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/string/string/git-receive-pack" \ -H "Content-Type: application/x-git-receive-pack-request" \ -d 'string'"string"/internal/cli/integrations/{integrationId}/invocations/{invocationId}/executeintegrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuiduuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/internal/cli/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invocations/497f6eca-6276-4993-bfeb-53cbbbba6f08/execute" \ -H "Content-Type: application/json" \ -d '{}'/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}integrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuiduuiduuidcurl -X GET "https://example.com/internal/cli/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invocations/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08"/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}integrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuiduuiduuidapplication/octet-stream
TypeScript Definitions
Use the request body type in TypeScript.
binarycurl -X PUT "https://example.com/internal/cli/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invocations/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/octet-stream" \ -d 'string'/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}/beginCreates a short-lived presigned PUT for one invocation-owned companion file. The runtime applies provider-specific type, size, count, and aggregate limits; no provider receives a public file URL.
integrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuiduuiduuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/internal/cli/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invocations/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08/begin" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "contentType": "string", "sizeBytes": 1, "sha256": "string" }'/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}/completeStreams the staged object to verify ownership, size, content type, server-calculated SHA-256, and any provider-specific signature before an action may be proposed.
integrationGatewayCapability Short-lived capability scoped to one organization, profile, integration, and execution.
In: header
uuiduuiduuidapplication/json
TypeScript Definitions
Use the request body type in TypeScript.
curl -X POST "https://example.com/internal/cli/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/invocations/497f6eca-6276-4993-bfeb-53cbbbba6f08/files/497f6eca-6276-4993-bfeb-53cbbbba6f08/complete" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "contentType": "string", "sizeBytes": 1, "sha256": "string" }'1 <= length <= 163841 <= length <= 641 <= length <= 16384Defaults to read_only when omitted.
Value in
When supplied, this explicit non-empty subset wins. When omitted, Oblive selects every tool currently eligible for the chosen access mode.
1 <= items <= 200Value in
1 <= items <= 9Value in
Value in
1 <= items <= 200Value in
1 <= length <= 2551 <= length <= 2551 <= value <= 1073741824^[a-f0-9]{64}$1 <= length <= 2551 <= length <= 2551 <= value <= 1073741824^[a-f0-9]{64}$