> ## 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 call's test match

> Which accepted test the call is an instance of, how sure SignalMD was, and how the call was checked against the test's criteria. 404 `case_match_not_found` when the call was never matched: the agent has no accepted tests, the call is not labelled yet, nobody spoke, or it came from the agent's own test line or test script.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/agents/{agentId}/calls/{callId}/case-matches
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}/calls/{callId}/case-matches:
    get:
      tags:
        - Tests
      summary: Get a call's test match
      description: >-
        Which accepted test the call is an instance of, how sure SignalMD was,
        and how the call was checked against the test's criteria. 404
        `case_match_not_found` when the call was never matched: the agent has no
        accepted tests, the call is not labelled yet, nobody spoke, or it came
        from the agent's own test line or test script.
      operationId: getCallCaseMatch
      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 call's id.
          required: true
          description: The call's id.
          name: callId
          in: path
      responses:
        '200':
          description: The match.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaseMatch'
        '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/calls/0b9e8d7c-6f5a-4b3c-9d2e-1f0a9b8c7d6e/case-matches"
            \
              -H "Authorization: Bearer $SIGNAL_API_KEY"
components:
  schemas:
    CaseMatch:
      type: object
      properties:
        object:
          type: string
          enum:
            - case_match
        callId:
          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
        testId:
          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
          description: The test this call is an instance of, or null for no match.
        reason:
          type: string
          enum:
            - attached
            - none_weight
            - below_bar
            - no_options
          description: >-
            attached: the call matched this test. none_weight: SignalMD was not
            sure the call is any of the tests offered. below_bar: the closest
            test was not sure enough to count as a match. no_options: the call's
            labels offered no accepted test. No match is final: nothing else is
            asked.
        p:
          type:
            - number
            - 'null'
          description: >-
            How sure SignalMD was that the call is this test, or of its top pick
            when none matched.
        none:
          type:
            - number
            - 'null'
          description: >-
            How sure SignalMD was that the call fits none of the tests offered.
            Null when it was not asked.
        shortlist:
          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
              revision:
                type: integer
            required:
              - id
              - revision
          description: The tests offered, at the revision offered.
        probabilities:
          type:
            - object
            - 'null'
          additionalProperties:
            type: number
          description: >-
            How sure SignalMD was of each test offered, by test id, with `other`
            for none of these.
        thresholds:
          type: object
          properties:
            attach:
              type: number
            noneMax:
              type: number
          required:
            - attach
            - noneMax
          description: The matching settings in force when it was decided.
        model:
          type:
            - string
            - 'null'
          description: The setup that decided the match, for comparing matches.
        decidedAt:
          type: string
          format: date-time
          example: '2026-10-02T14:03:07.120Z'
        verdicts:
          type: array
          items:
            type: object
            properties:
              testId:
                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
              revision:
                type: integer
                description: The test revision it was judged against.
              result:
                type: string
                enum:
                  - passed
                  - failed
                  - unclear
                description: >-
                  passed: every criterion decided and met. failed: at least one
                  not met, with the turn that shows it. unclear: anything left
                  undecided, including a call that never got to what a criterion
                  is about.
              failedCriteria:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    text:
                      type: string
                    detail:
                      type: string
                      description: >-
                        What was found when the call was checked: what went
                        wrong, not why.
                  required:
                    - id
                    - text
                    - detail
              judgeModel:
                type:
                  - string
                  - 'null'
                description: The setup that scored the call against this test revision.
              judgedAt:
                type: string
                format: date-time
                example: '2026-10-02T14:03:07.120Z'
            required:
              - testId
              - revision
              - result
              - failedCriteria
              - judgeModel
              - judgedAt
          description: >-
            Checks of this call against a test revision, one per revision,
            newest first.
      required:
        - object
        - callId
        - testId
        - reason
        - p
        - none
        - shortlist
        - probabilities
        - thresholds
        - model
        - decidedAt
        - verdicts
      example:
        object: case_match
        callId: 0b9e8d7c-6f5a-4b3c-9d2e-1f0a9b8c7d6e
        testId: 3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f
        reason: attached
        p: 0.9
        none: 0.05
        shortlist:
          - id: 3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f
            revision: 2
        probabilities:
          3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f: 0.9
          other: 0.05
        thresholds:
          attach: 0.6
          noneMax: 0.25
        model: review-setup-a
        decidedAt: '2026-10-02T14:05:11.400Z'
        verdicts:
          - testId: 3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f
            revision: 2
            result: failed
            failedCriteria:
              - id: goal
                text: The caller leaves with a booked cleaning.
                detail: 'false (#7): the agent said it could not check availability.'
            judgeModel: review-setup-a
            judgedAt: '2026-10-02T14:05:19.020Z'
    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
    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.