Skip to main content
POST
Call a connected app

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

accountId
string
required

Connected account id (cna_…)

Body

application/json
method
enum<string>
default:GET
required

HTTP method; read-only grants allow reads only

Available options:
GET,
HEAD,
POST,
PUT,
PATCH,
DELETE
path
string
required

Path under the app's API base, e.g. /v1/search for Notion, /api/conversations.list for Slack, /repos/o/r/issues for GitHub, or a full https URL on the app's API host

Required string length: 1 - 4000
headers
object

Only content-type and accept are accepted, where the app allows them

body
string

Request body as a string, usually JSON. Sent as application/json unless a content-type header says otherwise

Maximum string length: 1000000
idempotency_key
string

Pass one for every request that changes state. Repeating the same request with the same key within 24 hours returns the first response without calling the app again; another request under the key, or a repeat while the first still runs, is refused. Also sent to the app as the Idempotency-Key header

Required string length: 1 - 200

Response

Provider response

request_id
string
status
integer
ok
boolean
content_type
string | null
body
string
truncated
boolean
duration_ms
integer
replayed
boolean

The stored response of an earlier request with the same idempotency_key