> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sidenet.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get copilot configuration (DEPRECATED → GET /v1/copilots/:id)

> DEPRECATED: use GET /v1/copilots/:id instead, which returns the copilot's agents + workflows (with name + description), sdk_ui, and runtime auth providers. Kept for backward compatibility during migration.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/copilot-config
openapi: 3.1.0
info:
  title: Sidenet API
  version: 1.0.0
  description: >-
    Custom HTTP endpoints exposed by the Sidenet Mastra server. All routes
    require a bearer token and resolve org context from the API key (or the
    `X-Organization-Id` header). This reference is generated from the live route
    definitions in `src/mastra/routes`.
servers:
  - url: ''
security:
  - bearerAuth: []
paths:
  /v1/copilot-config:
    servers:
      - url: /
    get:
      tags:
        - V1
      summary: Get copilot configuration (DEPRECATED → GET /v1/copilots/:id)
      description: >-
        DEPRECATED: use GET /v1/copilots/:id instead, which returns the
        copilot's agents + workflows (with name + description), sdk_ui, and
        runtime auth providers. Kept for backward compatibility during
        migration.
      parameters:
        - in: query
          name: copilotId
          schema:
            type: string
          description: Copilot identifier (alternative to X-Copilot-Id header)
          required: false
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            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.
        - name: X-User-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            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.
      responses:
        '200':
          description: Copilot configuration retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  orgId:
                    type: string
                  sdk_ui:
                    description: SDK UI configuration (nullable)
                  agents:
                    type: array
                    description: >-
                      The copilot's agents (each resolved through its active
                      version).
                    items:
                      type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - agent
                        id:
                          type: string
                          description: agents.id (stable reference)
                        versionId:
                          type: string
                          description: active agent_versions.id
                        mastraId:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                  workflows:
                    type: array
                    description: >-
                      The copilot's workflows (each resolved through its active
                      version).
                    items:
                      type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - workflow
                        id:
                          type: string
                          description: workflows.id (stable reference)
                        versionId:
                          type: string
                          description: active workflow_versions.id
                        name:
                          type: string
                        description:
                          type: string
                  runtimeAuthProviders:
                    type: array
                    items:
                      type: object
                      properties:
                        providerName:
                          type: string
                        description:
                          type: string
                        authType:
                          type: string
                        authFields:
                          type: array
                          items:
                            type: string
        '400':
          description: Bad request - missing copilotId or organization ID
        '403':
          description: Forbidden - copilot does not belong to organization
        '404':
          description: Not found - copilot or routing agent not found
        '500':
          description: Internal server error
      deprecated: true
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Org API key (scopes the request to its organization) or the shared
        trusted key (requires `X-Organization-Id` on every request).

````