> ## Documentation Index > Fetch the complete documentation index at: https://docs.signalmd.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get a version > One version with its calls, Got it done, Handed to a person and captured configuration. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/agents/{agentId}/versions/{version} openapi: 3.1.0 info: title: SignalMD API version: 1.0.0 description: >- SignalMD reads a voice agent's production calls and says what to fix, then tests whether the fix worked. This API exposes the same data the web app shows: agents, calls and their traces, signals, issues, versions and their comparisons, tests, and test runs. Authenticate with `Authorization: Bearer sig_...` (an API key from the API keys page). Read keys may call every `read` operation; write keys may also call `write` operations, within their monthly budget. Each operation's scope is in `x-signal-scope`. Errors share one envelope (`Error`), lists share one cursor scheme (`limit`, `cursor`, `hasMore`, `nextCursor`), and every response carries `Request-Id` and `RateLimit-*` headers. servers: - url: https://api.signalmd.dev description: Production - url: http://localhost:43124 description: Local development security: - bearerAuth: [] tags: - name: Account description: Who the token belongs to and what it may do. - name: Agents description: Voice agents connected to the workspace. - name: Calls description: Production calls, their traces and per-call signals. - name: Signals description: What SignalMD noticed across calls. - name: Issues description: 'Problems worth fixing: where, why, and what to change.' - name: Versions description: Agent versions and how each one did. - name: Comparisons description: Stored comparisons between two versions. - name: Tests description: Tests, test sets, personas and coverage. - name: Runs description: Test runs and the attempts inside them. paths: /v1/agents/{agentId}/versions/{version}: get: tags: - Versions summary: Get a version description: >- One version with its calls, Got it done, Handed to a person and captured configuration. operationId: getVersion parameters: - schema: type: string format: uuid pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ example: 3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f description: The agent's id. required: true description: The agent's id. name: agentId in: path - schema: type: integer minimum: 0 description: The version number. example: 8 required: true description: The version number. name: version in: path responses: '200': description: The version. content: application/json: schema: $ref: '#/components/schemas/VersionDetail' '400': description: 'Invalid request: a parameter or the body failed validation.' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing, invalid or revoked credentials. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Not permitted for this principal. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- The agent, or a resource under it, does not exist or is not visible to this key. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limited. See Retry-After. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. The message is generic; quote the request id. content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: bash label: curl source: >- curl "https://api.signalmd.dev/v1/agents/6f1d2c3b-4a5e-4f60-8b7a-9c0d1e2f3a4b/versions/8" \ -H "Authorization: Bearer $SIGNAL_API_KEY" components: schemas: VersionDetail: allOf: - $ref: '#/components/schemas/Version' - type: object properties: config: $ref: '#/components/schemas/VersionConfig' required: - config Error: type: object properties: error: type: object properties: type: $ref: '#/components/schemas/ErrorType' code: type: string example: agent_not_found description: The specific reason; stable within v1. message: type: string example: Agent not found. param: type: - string - 'null' description: The request field at fault, for a validation error. requestId: type: - string - 'null' example: req_8c1f0e2b4a6d9e3f7a5c1b0d quota: type: object properties: metric: type: string example: credits description: >- credits when the workspace's monthly credits are used up, or agents when the plan's agent limit is reached. activity: type: string enum: - observation - testing - chat example: testing description: >- With metric credits: what the request would have spent them on. observation is analysing calls, testing is test runs, chat is the copilot. requested: type: integer example: 18 description: >- With metric credits: the credits the request needed to start. limit: type: integer description: 'The plan''s limit: the month''s credits, or its agents.' used: type: integer description: How much of the limit is used this month. plan: type: string example: free_org description: The workspace's plan slug. upgradePath: type: string example: /billing description: Where in the web app the plan is changed. required: - metric - limit - used - plan - upgradePath description: >- Present when code is quota_exceeded: the plan limit the request would pass. proposalId: type: string format: uuid description: >- Present when code is criteria_locked: the pending criteria proposal the change was filed as. A person approves or rejects it. required: - type - code - message - param - requestId required: - error example: error: type: not_found_error code: agent_not_found message: Agent not found. param: null requestId: req_8c1f0e2b4a6d9e3f7a5c1b0d Version: type: object properties: object: type: string enum: - version version: type: integer description: The version number on the voice platform. isCurrent: type: boolean description: The version live now. configCaptured: type: boolean description: >- Whether its configuration was captured. A version that shipped before the agent was connected ran calls but was never captured. detectedAt: type: - string - 'null' format: date-time example: '2026-10-02T14:03:07.120Z' description: >- When SignalMD first saw this version's configuration. Null when it was never captured. configHash: type: - string - 'null' description: >- `sha256:` over the configuration (agent, flow, components and LLM, keys sorted). Two versions with the same hash are configured the same. Null when the configuration was not captured. example: sha256:9f2c... calls: type: integer description: Every call on this version, silent ones included. gotItDone: $ref: '#/components/schemas/MetricSide' handedOff: allOf: - $ref: '#/components/schemas/MetricSide' - type: - object - 'null' description: >- The health board's Handed to a person. Null when no call on any of the agent's versions ended in a transfer, so a 0% would say nothing. required: - object - version - isCurrent - configCaptured - detectedAt - configHash - calls - gotItDone - handedOff VersionConfig: type: - object - 'null' properties: fetchedAt: type: - string - 'null' format: date-time example: '2026-10-02T14:03:07.120Z' description: When the configuration was read from the voice platform. summary: type: object properties: nodeCount: type: integer description: Steps in the conversation flow. edgeCount: type: integer description: Transitions between steps. componentCount: type: integer description: Reusable flow components. toolCount: type: integer phoneCount: type: integer kbCount: type: integer description: Knowledge bases. required: - nodeCount - edgeCount - componentCount - toolCount - phoneCount - kbCount tools: type: array items: type: string description: Names of the tools the agent can call. knowledgeBases: type: array items: type: object properties: id: type: string name: type: string required: - id - name phoneNumbers: type: array items: type: string description: The agent's own numbers. required: - fetchedAt - summary - tools - knowledgeBases - phoneNumbers description: Null when the configuration was not captured. ErrorType: type: string enum: - invalid_request_error - authentication_error - budget_error - permission_error - not_found_error - conflict_error - rate_limit_error - api_error MetricSide: type: object properties: value: type: - number - 'null' description: >- In the metric's unit: a share is 0 to 1, a time is seconds. Null when nothing is in the denominator. 'n': type: integer description: Calls in the metric's denominator. required: - value - 'n' description: >- The health board's Got it done: the share of its denominator whose caller got what they called for. securitySchemes: bearerAuth: type: http scheme: bearer description: An API key (`sig_...`), or a session token from the web app. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.