Skip to main content
POST
Connect an AI app

Authorizations

X-API-Key
string
header
required

Path Parameters

request_id
string
required
Required string length: 1 - 64

Body

application/json

The person's yes: which workspace, and what the app may do there.

access
enum<string>
required

What a person let one AI app do in their workspace when they connected it.

Chosen on the consent page. A workspace that is not on a paid plan reads as READ whatever was chosen, because making changes from an AI app is a paid entitlement; that is checked on every call, not stored here.

Available options:
read,
write
workspace_id
string
required
Required string length: 1 - 255

Response

Successful Response

Where to send the person once they have answered.

redirect_url
string
required