Integrations · Oblive Docs

List safe integrations visible to this execution

GET/internal/agent/organizations/{organizationId}/integrations

Returns control-plane readiness, enabled capabilities, access mode, department tags, and profile availability. Includes sanitized, generation-fenced provider health evidence. It never returns credentials, provider endpoints, or OAuth subjects.

Authorization

AuthorizationBearer <token>

Token used by trusted agent runtimes.

In: header

Path Parameters

organizationId*string

Formatuuid

Query Parameters

authorizationEpoch*integer

Range1 <= value

Response Body

curl -X GET "https://example.com/internal/agent/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations?authorizationEpoch=1"

Empty

Get one safe integration visible to this execution

GET/internal/agent/organizations/{organizationId}/integrations/{integrationKey}

Reads the authorization-fenced safe registry snapshot without contacting the provider.

Authorization

AuthorizationBearer <token>

Token used by trusted agent runtimes.

In: header

Path Parameters

organizationId*string

Formatuuid

integrationKey*string

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

Query Parameters

authorizationEpoch*integer

Range1 <= value

Response Body

curl -X GET "https://example.com/internal/agent/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string?authorizationEpoch=1"

Empty

Read provider order by purpose

GET/organizations/{organizationId}/integrations/preferences

One organization-owned revisioned order. First usable connections append; reconnects preserve position. Disconnected providers remain in the order but cannot be selected. Preferences rank only providers eligible for the requested operation, account, resources, permissions, and readiness.

Path Parameters

organizationId*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/preferences"

{  "success": true,  "statusCode": 0,  "message": "string",  "data": {    "revision": 0,    "order": {      "property1": [        "string"      ],      "property2": [        "string"      ]    }  },  "meta": {}}

Reorder providers for one purpose

PUT/organizations/{organizationId}/integrations/preferences/{purpose}

Owner mutation; requires the current document revision and an exact permutation of existing connector keys for this purpose. Concurrent connection changes return 409 rather than overwriting either order. Refreshes future runtime context without changing authorization or in-progress action receipts. All configured sources continue collecting metrics.

Path Parameters

organizationId*string

Formatuuid

purpose*string

Value in

"email_delivery"
"audience_management"
"outreach"
"mailbox"
"web_research"
"billing"
"engineering"
"lead_research"
"analytics"
"support"
"advertising"
"social"
"workspace"
"database"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/preferences/email_delivery" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0,    "connectorKeys": [      "string"    ]  }'

{  "success": true,  "statusCode": 0,  "message": "string",  "data": {    "revision": 0,    "order": {      "property1": [        "string"      ],      "property2": [        "string"      ]    }  },  "meta": {}}

Empty

Discover accessible integration resources

GET/organizations/{organizationId}/integrations/{integrationRef}/resources

Lists connected GitHub repositories in pages of 100, including their exact owner/name and default branch. Uses a fixed GitHub API origin, existing scoped credentials and read-only requests. The owner selects resources and saves them through the revision-fenced operating-context endpoint. Other providers retain their specialized selectors or exact-ID entry.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Query Parameters

page?integer

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/resources"

{  "success": true,  "statusCode": 0,  "message": "string",  "data": {    "context": {      "departments": [        "growth"      ],      "organizationPurpose": "string",      "departmentPurposes": {        "property1": "string",        "property2": "string"      },      "policy": "string",      "businessFunctions": [        "string"      ],      "taskPatterns": [        "string"      ],      "workflowKeys": [        "string"      ],      "resources": [        {          "kind": "repository",          "externalId": "string",          "name": "string",          "url": "http://example.com",          "defaultBranch": "string",          "departments": [            "growth"          ]        }      ]    },    "nextPage": -9007199254740991  },  "meta": {}}

Empty

List organization integrations

GET/organizations/{organizationId}/integrations

Retired catalog entries without credentials are omitted from the directory. Their retained records remain readable by ID for history and audit.

Path Parameters

organizationId*string

Formatuuid

Query Parameters

cursor?string

Opaque alphabetical pagination cursor.

limit?integer

Range1 <= value <= 200

Default20

kind?string

source?string

status?string

category?string

department?string

Response Body

`application/json`

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations"

{  "success": true,  "statusCode": 0,  "message": "string",  "data": [    {      "contextRevision": 0,      "credentialMetadata": {        "kind": "api_key",        "connectedAt": "2019-08-24T14:15:22Z",        "details": {          "provider": "resend",          "domains": {            "status": "missing_permission"          }        }      },      "purposes": [        "email_delivery"      ],      "description": "string",      "operatingContext": {},      "hasReportingCredentials": true,      "readOnlyProfileKeys": [        "string"      ],      "reviewRequiredTools": [        "string"      ],      "readiness": "ready",      "health": {        "kind": "integration_health",        "generation": "string",        "observations": [          {            "scope": "string",            "status": "verified",            "checkedAt": "2019-08-24T14:15:22Z"          }        ]      },      "settings": {        "kind": "aws",        "accountId": "string",        "region": "string",        "kubernetesEnabled": true,        "metrics": []      }    }  ],  "meta": {},  "pagination": {}}

Create a custom remote MCP integration

POST/organizations/{organizationId}/integrations

Requires a public HTTPS endpoint on a deployment-approved origin. Connections use direct HTTPS unless the deployment configures an optional egress proxy.

Path Parameters

organizationId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Get an organization integration

GET/organizations/{organizationId}/integrations/{integrationRef}

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Response Body

`application/json`

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string"

{  "success": true,  "statusCode": 0,  "message": "string",  "data": {    "contextRevision": 0,    "credentialMetadata": {      "kind": "api_key",      "connectedAt": "2019-08-24T14:15:22Z",      "details": {        "provider": "resend",        "domains": {          "status": "missing_permission"        }      }    },    "purposes": [      "email_delivery"    ],    "description": "string",    "operatingContext": {},    "hasReportingCredentials": true,    "readOnlyProfileKeys": [      "string"    ],    "reviewRequiredTools": [      "string"    ],    "readiness": "ready",    "health": {      "kind": "integration_health",      "generation": "string",      "observations": [        {          "scope": "string",          "status": "verified",          "checkedAt": "2019-08-24T14:15:22Z"        }      ]    },    "settings": {      "kind": "aws",      "accountId": "string",      "region": "string",      "kubernetesEnabled": true,      "metrics": []    }  },  "meta": {}}

Update a custom remote MCP integration

PATCH/organizations/{organizationId}/integrations/{integrationRef}

Updated endpoints must use public HTTPS and a deployment-approved origin. An egress proxy is optional.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Delete a custom remote MCP integration

DELETE/organizations/{organizationId}/integrations/{integrationRef}

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Response Body

curl -X DELETE "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string"

Empty

List GA4 properties available to the connected Google account

GET/organizations/{organizationId}/integrations/{integrationRef}/google-analytics/properties

Returns bounded, non-secret property options used to configure the Google Analytics integration. A Google Analytics credential must already be connected.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Response Body

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/google-analytics/properties"

Empty

Validate a Lemon Squeezy API key and list its bounded store snapshot

POST/organizations/{organizationId}/integrations/{integrationRef}/lemon-squeezy/stores

Uses 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.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`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": {}}

Empty

Validate MongoDB access and discover bounded collection and field options

POST/organizations/{organizationId}/integrations/{integrationRef}/mongodb/resources

Uses 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.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/mongodb/resources" \  -H "Content-Type: application/json" \  -d '{    "databaseName": "string"  }'

Empty

Remove an integration credential

DELETE/organizations/{organizationId}/integrations/{integrationRef}/credential

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Response Body

curl -X DELETE "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/credential"

Empty

Validate credentials, discover tools, and enable an integration

PUT/organizations/{organizationId}/integrations/{integrationRef}/credential

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/credential" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Update non-secret integration settings

PUT/organizations/{organizationId}/integrations/{integrationRef}/settings

Validates provider-specific resource boundaries and rediscovery before atomically updating settings.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/settings" \  -H "Content-Type: application/json" \  -d '{    "settings": {      "kind": "aws",      "accountId": "string",      "region": "string",      "metrics": []    }  }'

Empty

Start organization Google authorization

POST/organizations/{organizationId}/integrations/{integrationRef}/oauth/google/start

Starts 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.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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"    ]  }'

Empty

Start managed MCP provider authorization

POST/organizations/{organizationId}/integrations/{integrationRef}/oauth/mcp/start

Starts 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.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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"  }'

Empty

Complete Google authorization

GET/oauth/google/callback

Query Parameters

state?string

OAuth state for OAuth 2.0 providers. OAuth 1.0a providers return oauth_token instead.

code?string

error?string

scope?string

denied?string

oauth_token?string

oauth_verifier?string

Response Body

curl -X GET "https://example.com/oauth/google/callback"

Empty

Complete managed MCP provider authorization

GET/oauth/mcp/callback

Query Parameters

state*string

code?string

error?string

scope?string

Response Body

curl -X GET "https://example.com/oauth/mcp/callback?state=string"

Empty

Explicitly revoke the shared Google authorization

DELETE/organizations/{organizationId}/integrations/{integrationRef}/oauth/google/grant

Owner-only destructive operation. Revokes the combined Google grant and unlinks unchanged Google connections for the same account in this organization. Other connections using this Google application grant also require reconnection. Ordinary credential removal only unlinks one local connector and never invokes provider revocation. Returns revoked, disconnected connector keys, changed connector keys, and a human-readable message. A changed connection must be checked again; it is never overwritten by stale cleanup.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Response Body

curl -X DELETE "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/oauth/google/grant"

Empty

Verify and save reporting access

PUT/organizations/{organizationId}/integrations/{integrationRef}/reporting-credential

Owner-only Crisp reporting credentials. Verifies the REST website against the existing MCP website and performs a conversation read before encrypting the credential separately. Send credential:null to remove reporting access. Plaintext is never returned or delivered to agents.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/reporting-credential" \  -H "Content-Type: application/json" \  -d '{    "credential": {      "kind": "crisp",      "websiteId": "eee0b185-ac19-4fd6-bb45-58b59a8988e9",      "identifier": "string",      "key": "string",      "tier": "website"    }  }'

Empty

Check current integration authentication or tool inventory

POST/organizations/{organizationId}/integrations/{integrationRef}/check

Runs a bounded check and returns the integration projection with sanitized, generation-fenced health. Discovery verifies available tools, not access to every data operation. Actual operation results are tracked separately. Does not change grants, tools or settings.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Response Body

`application/json`

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/check"

{  "success": true,  "statusCode": 0,  "message": "string",  "data": {    "contextRevision": 0,    "credentialMetadata": {      "kind": "api_key",      "connectedAt": "2019-08-24T14:15:22Z",      "details": {        "provider": "resend",        "domains": {          "status": "missing_permission"        }      }    },    "purposes": [      "email_delivery"    ],    "description": "string",    "operatingContext": {},    "hasReportingCredentials": true,    "readOnlyProfileKeys": [      "string"    ],    "reviewRequiredTools": [      "string"    ],    "readiness": "ready",    "health": {      "kind": "integration_health",      "generation": "string",      "observations": [        {          "scope": "string",          "status": "verified",          "checkedAt": "2019-08-24T14:15:22Z"        }      ]    },    "settings": {      "kind": "aws",      "accountId": "string",      "region": "string",      "kubernetesEnabled": true,      "metrics": []    }  },  "meta": {}}

Discover policy-eligible MCP tools

POST/organizations/{organizationId}/integrations/{integrationRef}/discover

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Response Body

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/discover"

Empty

Enable or disable an integration

PATCH/organizations/{organizationId}/integrations/{integrationRef}/status

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/status" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Set owner-controlled agent access to an integration

PUT/organizations/{organizationId}/integrations/{integrationRef}/profiles

Replaces profile grants and optional read-only restrictions. Read-only profile keys must be granted access. Operator and Chat retain discovery access. Operator remains read-only; Chat can perform explicitly requested owner changes within current access restrictions. Changes invalidate active authorization and apply to MCP, CLI, Git, pending actions, and requirement admission. Built-in catalog upgrades preserve owner selections. Shared business metric aggregates remain available to enabled organizational profiles within current selected resource scope.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/profiles" \  -H "Content-Type: application/json" \  -d '{    "profileGrants": [      "string"    ],    "readOnlyProfileKeys": [      "string"    ]  }'

Empty

Set an integration tool allowlist and access mode

PUT/organizations/{organizationId}/integrations/{integrationRef}/tools

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/tools" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Save integration operating context

POST/organizations/{organizationId}/integrations/{integrationRef}/context-mapping

Replaces business usage and resource bindings in PostgreSQL with a context revision fence. No agentic refresh is scheduled. Credentials and tool permissions are unchanged.

Path Parameters

organizationId*string

Formatuuid

integrationRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/context-mapping" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0,    "context": {      "resources": [        {          "kind": "repository",          "externalId": "string",          "name": "string",          "departments": [            "growth"          ]        }      ]    }  }'

Empty

Replace integration operating context

PATCH/internal/agent/organizations/{organizationId}/integrations/{integrationKey}/context

Chat and Operator executions may replace purpose, usage, policy and resource bindings. Requires a current authorization epoch, active chat turn or task lease, and matching context revision. Department executions cannot change organization integration context. No semantic refresh is scheduled.

Authorization

agentExecutionCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, and task run or chat turn.

In: header

Path Parameters

organizationId*string

Formatuuid

integrationKey*string

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/internal/agent/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/string/context" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0,    "context": {      "resources": [        {          "kind": "repository",          "externalId": "string",          "name": "string",          "departments": [            "growth"          ]        }      ]    },    "authorizationEpoch": 1  }'

Empty

Resolve authorized integrations for one agent run

POST/internal/agent/organizations/{organizationId}/integrations/resolve

Authorization

agentServiceToken

AuthorizationBearer <token>

Token used by trusted agent runtimes.

In: header

Path Parameters

organizationId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/internal/agent/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/integrations/resolve" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Advertise scoped GitHub repository refs

GET/internal/git/integrations/{integrationId}/{owner}/{repository}/info/refs

Proxies 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.

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

owner*string

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$

repository*string

Match^[A-Za-z0-9_.-]{1,100}$

Query Parameters

service*string

Value in

"git-upload-pack"
"git-receive-pack"

Response Body

curl -X GET "https://example.com/internal/git/integrations/497f6eca-6276-4993-bfeb-53cbbbba6f08/string/string/info/refs?service=git-upload-pack"

"string"

Read a scoped GitHub repository through Git

POST/internal/git/integrations/{integrationId}/{owner}/{repository}/git-upload-pack

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

owner*string

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$

repository*string

Match^[A-Za-z0-9_.-]{1,100}$

Request Body

application/x-git-upload-pack-request

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

`application/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"

Propose or execute a scoped GitHub branch push

POST/internal/git/integrations/{integrationId}/{owner}/{repository}/git-receive-pack

Validates and privately stages a bounded receive-pack, then routes the branch update through the typed action lifecycle. An authorized exact 0000 probe returns an empty successful Git response without staging or creating an action. Shallow-clone boundaries are validated before branch updates and preserved in the staged request. Tags, deletions, push options, and more than 20 ref updates are rejected.

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

owner*string

Match^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$

repository*string

Match^[A-Za-z0-9_.-]{1,100}$

Request Body

application/x-git-receive-pack-request

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

`application/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"

Classify and execute a scoped CLI invocation

POST/internal/cli/integrations/{integrationId}/invocations/{invocationId}/execute

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

invocationId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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 '{}'

Empty

Download one bounded CLI output file

GET/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

invocationId*string

Formatuuid

fileId*string

Formatuuid

Response Body

curl -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"

Empty

Stage one bounded CLI input file

PUT/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

invocationId*string

Formatuuid

fileId*string

Formatuuid

Request Body

application/octet-stream

TypeScript Definitions

Use the request body type in TypeScript.

body*file

Formatbinary

Response Body

curl -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'

Empty

Create an exact-key private upload grant

POST/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}/begin

Creates 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.

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

invocationId*string

Formatuuid

fileId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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"  }'

Empty

Verify a privately staged companion file

POST/internal/cli/integrations/{integrationId}/invocations/{invocationId}/files/{fileId}/complete

Streams the staged object to verify ownership, size, content type, server-calculated SHA-256, and any provider-specific signature before an action may be proposed.

Authorization

integrationGatewayCapability

AuthorizationBearer <token>

Short-lived capability scoped to one organization, profile, integration, and execution.

In: header

Path Parameters

integrationId*string

Formatuuid

invocationId*string

Formatuuid

fileId*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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"  }'

Empty

200

200

200application/json

200application/json

409

422

200application/json

409

502

200application/json

201

200application/json

200

200

200

403

409

200application/json

400

409

200

400

409

200

200

200

200

200

409

502

503

303

303

200

409

502

200

403

409

422

200application/json

200

200

200

200

200

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`