Sign in
Integrations

Start an integration connect session

Changed on

Both entrypoints (agent + UI) use this endpoint.

Agent callers: agent_id in the payload is refused (the caller is the agent — spoofing another agent's id is a permission-boundary violation). The caller's own identity is injected instead. UI / user callers: agent_id is optional — when named, confirm creates the direct agent-credential binding + permission rules; when omitted, the credential connects unbound and an agent can be bound later through the credentials API.

post/integrations:connect

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /integrations:connect
  • Auth: HTTP bearer

Request body

agent_idstring nullable
auth_typestring nullable

Declared scheme name or kind to use for an api target

namestring nullable
oauth_app_registration_idstring nullable
preferred_flowstring nullable
reasonstring nullable
requested_scopesstring[]
vendorstring nullable

Vendor registry key (e.g. 'github'). Exactly one of vendor or api.

Response

Successful Response

unknown required

Changes

  • b14321831a5aRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 1963116624b1Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property