Get Test | Speechify API

from speechify import Speechify
client = Speechify(
    token="YOUR_TOKEN_HERE",
)
client.tts.agents.get_test(
    id="id",
)

{
  "id": "a3f47b2e-9c4d-4f1a-8b2d-3e7f9c1d5a6b",
  "agent_id": "agent-12345",
  "name": "Greeting Scenario Test",
  "description": "Test to verify the agent greets the caller by name when introduced.",
  "type": "scenario",
  "config": {
    "context": "The caller says: Hi, I'm Alice.",
    "success_criteria": "The agent greets Alice by name.",
    "success_examples": [
      "Hi Alice! How can I help you today?"
    ],
    "failure_examples": [
      "Hello! How can I help you?"
    ]
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "tool_mock_config": {
    "strategy": "selected",
    "no_match_behavior": "call_real_tool",
    "mocks": [
      {
        "tool_name": "get_account_balance",
        "response": {
          "balance": 1000,
          "currency": "USD"
        }
      }
    ]
  },
  "variables": {},
  "folder_id": "folder-67890"
}

Retrieve a test by ID.

Authentication

AuthorizationBearer

Enter the key with the Bearer prefix, e.g. ‘Bearer API_KEY|ACCESS_TOKEN’.

Path parameters

idstringRequired

Response

The requested test.

idstring

agent_idstring

namestring<=200 characters

descriptionstring<=2000 characters

typeenum

Discriminates the shape of AgentTest.config.

scenario - send one message to the agent and judge the response with an LLM.
tool - assert that the agent calls a specific tool given a context.
simulation - run a multi-turn conversation between the agent and an AI caller.

Allowed values:

configobject

Type-specific configuration document.

created_atdatetime

updated_atdatetime

tool_mock_configobject

Optional tool-mocking config applied during runs of this test.

variablesmap from strings to any

Per-test dynamic-variable overrides. Keys substitute {{key}} placeholders inside the test config at run-start. Unknown keys render as empty string, matching session dispatch behaviour.

folder_idstring or null

Folder the test belongs to; null = root (unfiled).