Skip to main content
GET
/
v1
/
copilot-config
Error
A valid request URL is required to generate request examples
{
  "orgId": "<string>",
  "sdk_ui": "<unknown>",
  "agents": [
    {
      "kind": "agent",
      "id": "<string>",
      "versionId": "<string>",
      "mastraId": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "workflows": [
    {
      "kind": "workflow",
      "id": "<string>",
      "versionId": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "runtimeAuthProviders": [
    {
      "providerName": "<string>",
      "description": "<string>",
      "authType": "<string>",
      "authFields": [
        "<string>"
      ]
    }
  ]
}

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.

Query Parameters

​
copilotId
string

Copilot identifier (alternative to X-Copilot-Id header)

Response

Copilot configuration retrieved successfully

​
orgId
string
​
sdk_ui
any

SDK UI configuration (nullable)

​
agents
object[]

The copilot's agents (each resolved through its active version).

​
workflows
object[]

The copilot's workflows (each resolved through its active version).

​
runtimeAuthProviders
object[]