API Changelog

Simulations Updates

Based on user feedback, we have made changes to Simulations with a comprehensive set of new endpoints to manage Test Cases, Test Suites, and Simulation Sessions programmatically.

Key changes:

• Test suites are attached to specific agents and can only run on the agent they were designed for
• Test case generation now supports flow builder agents
• All of your previously created Agent-based tests will now be grouped into a Test Suite.
• Your Custom test cases will also be grouped, based on the most recently updated agent on your workspace. These changes are designed to make your test management clearer and more organised.
• Scenarios are separate entities used when generating test cases to ensure coverage of specific situations

Simulation cases

Simulation suites

Simulation runs and sessions

Upcoming Changes

The following changes are planned for simulation case CRUD endpoints:

Field Deprecation:

• The type field in simulation case payloads is deprecated and will be removed in a future version. Please remove this field from your API requests.

New Required Fields: In upcoming releases, the following fields will become mandatory:

• suite_id — Test suite identifier. All simulation cases must be associated with a suite.
• base_agent_id — The agent ID the test case is based on. This ensures proper association between test cases and agents.

Please update your integrations to include these fields to ensure compatibility with future API versions.

Read more about the feature here.

Analytics Export: Date-Time Parameters

The from_date and to_date parameters in the analytics export endpoint now accept datetime values instead of date-only values, allowing for more precise time-based filtering.

Changes:

• from_date and to_date parameters now use date-time format instead of date format
• Both parameters accept ISO 8601 datetime strings (e.g., 2025-11-25T14:30:00Z)

GPT-5.1 is now supported

Added GPT-5.1 support for agents.

1
"agent": {
2
   "llm": "gpt-5.1"
3
 }

Knowledge Base Sources: Content field added

Added a new content field to the knowledge base sources endpoint to provide text content directly when adding text sources.

• PDF/Web sources: Use url field with a link to the hosted file or webpage
• Text sources: Use content field to provide text directly

List Calls Response Update

The GET /v2/calls endpoint now returns additional call metadata and pagination information to provide more comprehensive call details.

New Fields:

• pagination object with total_records, limit, and offset for paginated responses
• judge_results — Call quality judging results
• agents_used — Array of agents used during the call
• executed_actions — Actions executed during the call
• type_of_call — Call direction (inbound/outbound)
• error_message — Error details if call failed
• call_status — Current status of the call
• labels — Array of labels associated with the call
• agent_phone_number — Phone number used by the agent
• deployment_type — Type of deployment
• name — Name of the call recipient

Removed Fields:

• timeline, recording_sid, and voice_engine_type are no longer returned

New Webhook Logs Endpoints

We’ve added two endpoints to manage Webhook Logs programmatically.

New Simulations Endpoints

We’ve added a comprehensive set of new endpoints to manage Simulation Cases, Simulation Suites, and Simulation Sessions programmatically.

• Case Management: Create, list, retrieve, update, delete, and generate simulation cases.
• Suite Management: Create, execute, and maintain suites that group related cases.
• Simulation Runs & Sessions: Start simulations and review run/session data.

Simulation cases

Simulation suites

Simulation runs and sessions

Read more about the feature here.

Subaccount Update: Import/Return Products

Added support to the update subaccount endpoint to manage importing objects like phone numbers from the parent workspace to subaccounts.

• New optional field operation_type (string): allowed values import, return.
• New optional field products.phone_numbers[].number to specify E.164 numbers to import to or return from the subaccount_id.

New timeout value for custom actions

You can now specify a failure_timeout field when creating or updating a custom action. This allows you to control how long a custom action is allowed to run before it is automatically terminated if the timeout is reached.

Deprecated Language Value

The es language code is no longer supported. Please use es-ES for Spanish when creating or updating agents.

Phone books: new API endpoints

New endpoints added: