OpenAPI 3.1.02026-08-193781,4532.0 MB

f053c821dc18

access:all2

Agents Insights1

Agents Platform147

Agents Workspace Analytics2

Assets4

audio-isolation4

audio-native4

Conversational AI7

dubbing20

Dubbing17

Flows9

forced-alignment1

models1

music-finetunes5

music-generation7

productions11

Pronunciation Dictionary9

pvc-voices14

samples2

Single Use Token1

sound-generation1

Speech Engine5

speech-history5

speech-to-speech2

speech-to-text3

studio23

text-to-dialogue4

text-to-speech4

text-to-voice5

video-to-music1

voices14

workspace29

Run Tests On The Agent

Run selected tests on the agent with provided configuration. If the agent configuration is provided, it will be used to override default agent configuration.

post/v1/convai/agents/{agent_id}/run-tests

Path parameters

agent_idstring required

The id of an agent. This is returned on agent creation.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

The id of an agent. This is returned on agent creation.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

branch_idstring nullable

ID of the branch to run the tests on. If not provided, the tests will be run on the agent's main branch.

repeat_countinteger

Number of times to run each test. When greater than 1, results are grouped and summarized.

Response

Successful Response

idstring required

agent_idstring nullable

branch_idstring nullable

created_atinteger

folder_idstring nullable

repeat_countinteger

bucketing_status'pending' | 'completed' | 'failed'