Review voice test — Brigg developers

Access & visibility

Allow voice.ReviewVoiceTest on your API key.

Acting member required. Send Brigg-Act-As with an approved member account ID. The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

test_idstringRequired

Keep the returned test_id for this temporary session. Expired sessions require a new test. voice.StartVoiceTest.

At least 1 character.

transcriptarray of objectRequired

Complete caller/agent conversation to review in order. Brigg does not reconstruct it from previous RunVoiceTestTurn calls.

At most 200 items.

Item fields

rolestringRequired

Conversation speaker: caller is the simulated customer; agent is the assistant. This is not a workspace permission or member role.

Allowed: "caller", "agent".

textstringRequired

The words spoken by this participant, in conversation order.

At most 4000 characters.

Run a conversation test

Start a test for the intended inbox and retain its test_id. Text clients can use Run voice test turn; an audio connection URL is only needed for an audio client. Keep temporary connection URLs secret.

Pass the simulated caller's utterance and previous conversation history in order. Keep a stable turn_id for a retried turn. Review the returned reply and capability trace; a simulated response is not evidence that a real customer call succeeded. Review voice test accepts the conversation transcript for feedback. End the session when finished; an expired session needs a new start.

Response

Returns 200 OK with a JSON body.

rowsarray of ReviewVoiceTestRowsRequired

Generated feedback on the submitted transcript. Empty means no feedback was returned, including when generation could not produce a review; it is not a pass/fail certification.

Item fields

statusstringRequired

ok describes a handled instruction; gap identifies missing guidance. These are review findings, not the status of the voice test session.

Allowed: "ok", "gap".

textstringRequired

Text content.

suggestionstringOptional

Suggested change to the assistant's instructions based on the review.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.
403	`voice_test_expired`	The test expired, is unknown, or belongs to another member. Start a new test under the intended approved member.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "test_id": {
      "type": "string",
      "minLength": 1,
      "description": "Keep the returned test_id for this temporary session. Expired sessions require a new test. [voice.StartVoiceTest](/reference/voice/StartVoiceTest)."
    },
    "transcript": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "enum": [
              "caller",
              "agent"
            ],
            "description": "Conversation speaker: caller is the simulated customer; agent is the assistant. This is not a workspace permission or member role."
          },
          "text": {
            "type": "string",
            "maxLength": 4000,
            "description": "The words spoken by this participant, in conversation order."
          }
        },
        "required": [
          "role",
          "text"
        ],
        "additionalProperties": false
      },
      "maxItems": 200,
      "description": "Complete caller/agent conversation to review in order. Brigg does not reconstruct it from previous RunVoiceTestTurn calls."
    }
  },
  "required": [
    "test_id",
    "transcript"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "test_id": "voice_test_kickoff",
      "transcript": [
        {
          "role": "caller",
          "text": "Discuss the pilot timeline and agree on next steps."
        }
      ]
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "rows": {
      "type": "array",
      "items": {
        "title": "ReviewVoiceTestRows",
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "ok",
              "gap"
            ],
            "description": "ok describes a handled instruction; gap identifies missing guidance. These are review findings, not the status of the voice test session."
          },
          "text": {
            "type": "string",
            "description": "Text content."
          },
          "suggestion": {
            "type": "string",
            "description": "Suggested change to the assistant's instructions based on the review."
          }
        },
        "required": [
          "status",
          "text"
        ],
        "additionalProperties": false
      },
      "description": "Generated feedback on the submitted transcript. Empty means no feedback was returned, including when generation could not produce a review; it is not a pass/fail certification."
    }
  },
  "required": [
    "rows"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "rows": [
        {
          "status": "ok",
          "text": "Discuss the pilot timeline and agree on next steps."
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Requires BRIGG_ACT_AS: an approved member account ID.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/voice.ReviewVoiceTest' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "test_id": "voice_test_kickoff",
  "transcript": [
    {
      "role": "caller",
      "text": "Discuss the pilot timeline and agree on next steps."
    }
  ]
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/voice.ReviewVoiceTest", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "test_id": "voice_test_kickoff",
    "transcript": [
      {
        "role": "caller",
        "text": "Discuss the pilot timeline and agree on next steps."
      }
    ]
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "test_id": "voice_test_kickoff",
  "transcript": [
    {
      "role": "caller",
      "text": "Discuss the pilot timeline and agree on next steps."
    }
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/voice.ReviewVoiceTest",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "rows": [
    {
      "status": "ok",
      "text": "Discuss the pilot timeline and agree on next steps."
    }
  ]
}

Illustrative values, not a live response.