> ## 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 goal's status > The goal as it stands, computed from the store: each case's state, stability and latest verdict, the criteria proposals still pending, its drafts and runs, and its spend. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/agents/{agentId}/goals/{goalId} 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}/goals/{goalId}: get: tags: - Goals summary: Get a goal's status description: >- The goal as it stands, computed from the store: each case's state, stability and latest verdict, the criteria proposals still pending, its drafts and runs, and its spend. operationId: getGoal 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: 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 goal's id. required: true description: The goal's id. name: goalId in: path responses: '200': description: The goal. content: application/json: schema: $ref: '#/components/schemas/GoalStatus' '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/goals/" \ -H "Authorization: Bearer $SIGNAL_API_KEY" components: schemas: GoalStatus: allOf: - $ref: '#/components/schemas/Goal' - type: object properties: cases: type: array items: type: object properties: id: 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 title: type: - string - 'null' revision: type: integer state: type: - string - 'null' description: draft, accepted or archived. stability: type: string description: >- The calibration: uncalibrated, calibrating, stable, reproduces, does_not_reproduce, flaky. k: type: - integer - 'null' 'n': type: - integer - 'null' latestVerdict: type: - object - 'null' properties: verdict: type: string why: type: - string - 'null' at: type: string format: date-time example: '2026-10-02T14:03:07.120Z' required: - verdict - why - at inPlan: type: boolean required: - id - title - revision - state - stability - k - 'n' - latestVerdict - inPlan pendingProposals: type: array items: type: object properties: id: 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 testCaseId: 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 createdAt: type: string format: date-time example: '2026-10-02T14:03:07.120Z' required: - id - testCaseId - createdAt description: Criteria changes waiting for a person. drafts: type: array items: type: object properties: id: 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 title: type: string status: type: string newCaseIds: type: array items: 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 updatedAt: type: string format: date-time example: '2026-10-02T14:03:07.120Z' required: - id - title - status - newCaseIds - updatedAt runs: type: array items: type: object properties: id: 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 kind: type: string status: type: string draftId: type: - string - 'null' 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 costUsd: type: number createdAt: type: string format: date-time example: '2026-10-02T14:03:07.120Z' required: - id - kind - status - draftId - costUsd - createdAt spend: $ref: '#/components/schemas/GoalSpend' required: - cases - pendingProposals - drafts - runs - spend 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 Goal: type: object properties: object: type: string enum: - goal id: 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 agentId: 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 title: type: string request: type: string description: What the person asked for, in their words. origin: type: string enum: - copilot - mcp - api status: type: string enum: - open - closed conversationId: type: - string - 'null' 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 plan: type: object properties: approved: type: boolean approvedAt: type: - string - 'null' format: date-time example: '2026-10-02T14:03:07.120Z' approvedBy: type: - string - 'null' testCaseIds: type: array items: 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 cases the approved plan covers. required: - approved - approvedAt - approvedBy - testCaseIds createdBy: type: - string - 'null' createdAt: type: string format: date-time example: '2026-10-02T14:03:07.120Z' updatedAt: type: string format: date-time example: '2026-10-02T14:03:07.120Z' required: - object - id - agentId - title - request - origin - status - conversationId - plan - createdBy - createdAt - updatedAt GoalSpend: type: object properties: goalId: 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 title: type: string status: type: string model: type: object properties: inputTokens: type: integer outputTokens: type: integer usd: type: number bySource: type: object properties: copilot_turn: type: object properties: inputTokens: type: integer outputTokens: type: integer usd: type: number required: - inputTokens - outputTokens - usd client_reported: type: object properties: inputTokens: type: integer outputTokens: type: integer usd: type: number required: - inputTokens - outputTokens - usd quick_check: type: object properties: inputTokens: type: integer outputTokens: type: integer usd: type: number required: - inputTokens - outputTokens - usd required: - copilot_turn - client_reported - quick_check required: - inputTokens - outputTokens - usd - bySource description: >- Model tokens and dollars: the copilot's turns, quick checks, and what a client reported. retell: type: object properties: runs: type: integer retellUsd: type: number signalUsd: type: number required: - runs - retellUsd - signalUsd description: The goal's Retell runs and their cost. totalUsd: type: number required: - goalId - title - status - model - retell - totalUsd ErrorType: type: string enum: - invalid_request_error - authentication_error - budget_error - permission_error - not_found_error - conflict_error - rate_limit_error - api_error 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.