Skip to main content
POST
/
v1
/
copilots
/
{id}
/
deploy
Error
A valid request URL is required to generate request examples

Authorizations

​
Authorization
string
header
required

Org API key (scopes the request to its organization) or the shared trusted key (requires X-Organization-Id on every request).

Headers

​
X-Organization-Id
string

Organization to scope the request to. Optional when authenticating with an org API key (the org is taken from the key; if sent, it must match). Required when authenticating with the trusted key.

​
X-User-Id
string

End-user identity for the request; user-scoped data (threads, memory) resolves to {orgId}_{userId}. Required by endpoints that read or write user-scoped resources. A userId query param (or body field, where documented) is accepted as a fallback.

Path Parameters

​
id
string
required

Body

application/json
​
target_copilot_id
string
required

Response

Deployed