Skip to main content
POST
Connect app with credentials

Authorizations

Authorization
string
header
required

API key obtained from the dashboard or GET /user/api-key

Path Parameters

provider
string
required

App provider identifier (e.g., gmail, github, jira)

Body

application/json
fields
object
required

Credential fields required by the app

Example:
connectionId
string

Reconnect an existing connection

label
string

Display label for the connection. Defaults to a label derived from the credential metadata.

method
string

Connection method to use for apps with multiple methods (e.g. OAuth primary + API-key alternate). An unrecognized value is rejected.

Response

Connected. connection is present only when a brand-new connection was created — reconnects and label-matched duplicates return success alone (an existing connection keeps whatever grants it has).

success
boolean
connection
object

The freshly created connection. Use its id to grant agents access (PUT /agents/{agentId}/grants/connections/{connectionId}).