ElevenLabs Convai API
The Convai API from ElevenLabs — 14 operation(s) for convai.
ElevenLabs Convai API is one of 50 APIs that ElevenLabs publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Convai. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, rate-limit docs, and an AsyncAPI specification.
This API exposes 20 operations across 14 paths, and defines 475 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against the base URL https://api.elevenlabs.io.
20 operations
14 paths
475 schemas
2 DELETE8 GET1 PATCH8 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 20
Across 14 paths, the API surfaces 20 operations — 2 DELETE, 8 GET, 1 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Convai 20
POST
/v1/convai/agent-testing/create
Create Agent Response Test
GET
/v1/convai/agent-testing/{test_id}
Get Agent Response Test By Id
PUT
/v1/convai/agent-testing/{test_id}
Update Agent Response Test
DELETE
/v1/convai/agent-testing/{test_id}
Delete Agent Response Test
POST
/v1/convai/agent-testing/summaries
Get Agent Response Test Summaries By Ids
GET
/v1/convai/agent-testing
List Agent Response Tests
GET
/v1/convai/test-invocations
List Test Invocations
POST
/v1/convai/agents/{agent_id}/run-tests
Run Tests On The Agent
GET
/v1/convai/test-invocations/{test_invocation_id}
Get Test Invocation
POST
/v1/convai/test-invocations/{test_invocation_id}/resubmit
Resubmit Tests
GET
/v1/convai/agents/{agent_id}/triage-tickets
List Agent Conversation Tickets
POST
/v1/convai/agents/{agent_id}/triage-tickets
Create Manual Agent Ticket
GET
/v1/convai/triage-tickets
List Workspace Conversation Tickets
POST
/v1/convai/triage-tickets
Create Agent Conversation Ticket
GET
/v1/convai/agents/{agent_id}/triage-tickets/assignable-users
Get Agent Conversation Ticket Assignable Users
GET
/v1/convai/triage-tickets/{agentqa_ticket_id}
Get Agent Conversation Ticket
PATCH
/v1/convai/triage-tickets/{agentqa_ticket_id}
Update Agent Conversation Ticket
DELETE
/v1/convai/triage-tickets/{agentqa_ticket_id}
Delete Agent Conversation Ticket
POST
/v1/convai/triage-tickets/{agentqa_ticket_id}/comments
Add Comment To Agent Conversation Ticket
POST
/v1/convai/triage-tickets/{agentqa_ticket_id}/turn-comments
Add Turn Comment To Agent Conversation Ticket
Schemas 475
The contract defines 475 schemas that model the data the API accepts and returns. The most detailed are WidgetTextContents (50 properties), WidgetConfig-Input (49 properties), ConversationHistoryTranscriptCommonModel-Output (23 properties), ConversationHistoryTranscriptCommonModel-Input (23 properties). Each schema is shown below with its type and property counts.
ListProductsParams
object
2 properties
KnowledgeBaseRagToolStatus
string
AgentConversationTicketIssueType
string
TTSOptimizeStreamingLatency
integer
ConversationConfigOverrideConfig
object
2 properties
ToolErrorHandlingMode
string
Controls how tool errors are processed before being shared with the agent.
ASTLessThanOrEqualsOperatorNode-Input
object
3 properties
2 required
WorkflowOverrideAgentNodeModel-Input
object
9 properties
1 required
ASTLessThanOperatorNode-Input
object
3 properties
2 required
TestRunMetadata
object
4 properties
3 required
TestRunStatus
string
AlertingSettings
object
Alerting configuration used at both per-agent and per-workspace level. Cascade order for per-monitor threshold and auto-resolve: agent → workspace → system def…
3 properties
CreateResponseUnitTestRequest
object
11 properties
1 required
ClientEvent
string
TicketCommentResponseModel
object
3 properties
3 required
SentimentAnalysisSettings
object
RagConfig-Input
object
8 properties
DTMFInputConfig
object
Configuration for DTMF (keypad) input collection during phone calls.
3 properties
EmbedVariant
string
BuiltInTools-Input
object
System tools a conversational agent can be given. Deliberately not named ConversationalBuiltInTools: BuiltInToolsInput and BuiltInToolsOutput are part of the p…
7 properties
MockNoMatchBehavior
string
ThresholdGuardrail
object
2 properties
AgentWorkflowRequestModel
object
3 properties
RequiredConstraints
object
Wrapper for anyOf/allOf composition constraints scoped to required fields.
2 properties
ListCalendarEventsParams
object
2 properties
PreToolSpeechMode
string
ToolResponseMockConfig-Output
object
3 properties
1 required
AttachedUserDataCollectionRef
object
4 properties
2 required
CreateAgentProcedureParams
object
1 property
ImageAvatar
object
2 properties
VoicemailDetectionToolConfig
object
Allows the agent to detect when a voicemail system is encountered. This tool should be invoked by the LLM when it detects that the call has been answered by a…
2 properties
UnitTestToolCallEvaluationModel-Input
object
4 properties
UnitTestWorkflowNodeTransitionEvaluationNodeId
object
3 properties
2 required
KnowledgeBaseRagChunkModel
object
3 properties
3 required
CreateProductParams
object
1 property
RestoreCalendarEventParams
object
1 property
TurnConfigWorkflowOverride
object
14 properties
CreateHolidayParams
object
1 property
OutputFormat
string
StartProcedureToolResultErrorModel
object
4 properties
2 required
ConversationHistoryMultivoiceMessagePartModel
object
Represents a single voice part of a multi-voice message.
3 properties
3 required
BackgroundSoundSourceType
string
The type of background sound source.
UserFeedback
object
2 properties
2 required
TTSConversationalConfigOverrideConfig
object
7 properties
DeleteClientParams
object
Delete a client, cascading deletion of all their appointments first.
1 property
WorkflowStartNodeModel-Input
object
3 properties
ASTNode-Input
OmitSchemaOverride
object
1 property
SoftTimeoutConfigOverrideConfig
object
2 properties
ConvAIEnvVarLocator
object
Used to reference an environment variable by label.
1 property
1 required
KnowledgeBaseToolResultModel
object
4 properties
ASTSubtractionOperatorNode-Input
object
3 properties
2 required
DeleteStaffParams
object
Delete an existing staff member from the system.
1 property
WorkflowToolMaxIterationsExceededStepModel
object
3 properties
2 required
GuardrailsV1-Input
object
6 properties
DynamicVariableUpdateCommonModel
object
Tracks a dynamic variable update that occurred during tool execution.
6 properties
6 required
FileInputConfigWorkflowOverride
object
3 properties
ListClientsParams
object
List clients ordered by most recently updated, with an optional limit.
1 property
CreateAssetParams
object
1 property
MCPApprovalPolicy
string
Defines the MCP server-level approval policy for tool execution.
ConversationHistoryTranscriptApiIntegrationWebhookToolsResultCommonModel-Input
object
14 properties
6 required
LanguagePresetTranslation
object
2 properties
2 required
AddTicketCommentRequestModel
object
1 property
1 required
UpdateBookingPageAppearanceParams
object
1 property
UpdateHolidayParams
object
1 property
AgentHoldAudioConfig
object
Custom hold audio played on loop to callers waiting in the agent's queue. Set by uploading a file through the agent hold-audio endpoint. Values sent in agent c…
5 properties
5 required
TestConditionResultCommonModel
object
2 properties
1 required
TurnCommentRequestModel
object
2 properties
2 required
ObjectJsonSchemaProperty-Input
object
9 properties
TTSOutputFormat
string
OptOutSmsReminderParams
object
1 property
ListAgentProceduresParams
object
1 property
EvaluationSettings-Input
object
Settings to evaluate an agent's performance. Agents are evaluated against a set of criteria, with success being defined as meeting some combination of those cr…
1 property
ASTNullNode-Input
object
1 property
VoiceMailDetectionResultSuccessModel
object
4 properties
BackgroundSoundConfig
object
4 properties
TransferToAgentToolResultSuccessModel-Input
object
11 properties
3 required
AgentTestFolderPathSegmentResponseModel
object
2 properties
1 required
WorkflowToolResponseModel-Input
object
A common model for workflow tool responses.
1 property
KnowledgeBaseToolStatus
string
KnowledgeBaseLocator
object
4 properties
3 required
InteractionBudget
string
UpdateSimulationTestRequest
object
17 properties
1 required
TextNormalisationType
string
Method for converting numbers to words before sending to TTS
ListServicesParams
object
2 properties
LLMLiteralJsonSchemaProperty
object
3 properties
2 required
AgentTestEntityType
string
TestConditionRationaleCommonModel
object
Structured rationale for test condition results containing individual failure/success reasons.
2 properties
UpdateServiceParams
object
Update an existing service's information.
1 property
ConversationHistoryTranscriptCommonModel-Input
object
23 properties
2 required
WidgetStyles
object
20 properties
ASTNotEqualsOperatorNode-Input
object
3 properties
2 required
ASRInputFormat
string
SimulationTestModel
object
15 properties
GetScheduleParams
object
2 properties
UpdateOrderParams
object
1 property
TurnModel
string
Version of the turn detection model to use.
EndCallTriggerAction
object
1 property
ConversationHistoryTranscriptOtherToolsResultCommonModel
object
11 properties
5 required
SupportedVoice
object
9 properties
2 required
GetSimulationTestResponseModel
object
17 properties
2 required
CancelCalendarEventParams
object
1 property
ConversationHistoryTranscriptSystemToolResultCommonModel-Input
object
12 properties
6 required
AgentTestingSettings
object
Settings for agent testing configuration.
1 property
DeleteGroupSessionParams
object
Permanently remove a previously-cancelled group session. Group analogue of deletecalendarevent: cancel (cancelgroupsessionforall) is the soft, history-preservi…
1 property
UpdateStaffParams
object
Update an existing staff member's information.
1 property
PlayDTMFToolConfig
object
Allows the agent to play DTMF tones during a phone call. This tool can be used to interact with automated phone systems, such as navigating phone menus, enteri…
3 properties
ConversationInitiationSource
string
Enum representing the possible sources for conversation initiation.
ASTNumberNode-Input
object
2 properties
1 required
GetTestSuiteInvocationResponseModel
object
11 properties
2 required
LLMReasoningEffort
string
GetAppointmentByConfirmationNumberParams
object
Look up an appointment by the booking confirmation number the caller quotes. The confirmation number is the 8-character code shown on the booking confirmation…
1 property
TurnConfigOverride
object
1 property
AlertingWebhookNotifier
object
2 properties
1 required
AttachedSystemEvaluationRef
object
4 properties
2 required
UnitTestRunResponseModel
object
18 properties
5 required
UUITransferConfig
object
User-to-User Information envelope for SIP REFER transfers (RFC 7433). Outbound payloads are hex-encoded (the only encoding RFC 7433 defines). The protocol disc…
3 properties
1 required
ClientToolConfig-Input
object
A client tool is one that sends an event to the user's client to trigger something client side
16 properties
2 required
ASTGreaterThanOrEqualsOperatorNode-Input
object
3 properties
2 required
CreateTransferRuleParams
object
2 properties
TransferToAgentToolResultErrorModel
object
4 properties
2 required
AuthConnectionLocator
object
Used to reference an auth connection from the workspace's auth connection store.
1 property
1 required
ListLocationsParams
object
Params + Reception-proxied run() for listlocations.
1 property
GetAgentConversationTicketsPageResponseModel
object
3 properties
2 required
ModerationGuardrail-Input
object
2 properties
TransferTypeEnum
string
UpdateBookingPageSettingsParams
object
1 property
TransferToNumberToolConfig-Input
object
3 properties
1 required
ConversationConfig-Input
object
9 properties
PlayDTMFResultSuccessModel
object
4 properties
1 required
PromptEvaluationCriteria
object
An evaluation using the transcript and a prompt for a yes/no achieved answer
10 properties
3 required
ASTMultiplicationOperatorNode-Input
object
3 properties
2 required
AgentMetadata
object
4 properties
1 required
AgentConfigOverrideConfig
object
4 properties
RagConfigWorkflowOverride-Input
object
8 properties
WorkflowExpressionConditionModel-Input
object
3 properties
1 required
TestFromConversationMetadata-Input
object
5 properties
2 required
TransferToNumberResultExotelSuccessModel
object
6 properties
1 required
AgentTransfer-Input
object
8 properties
1 required
SkipTurnToolResponseModel
object
3 properties
FocusGuardrail
object
1 property
DeleteLocationParams
object
1 property
WorkflowEndNodeModel-Input
object
3 properties
CreateClientAppointmentParams
object
1 property
PromptAgentAPIModelOverrideConfig
object
5 properties
PromptInjectionGuardrail
object
1 property
AttachedUserEvaluationRef
object
6 properties
2 required
ASTDynamicVariableNode-Input
object
2 properties
1 required
SIPUriDynamicVariableTransferDestination
object
2 properties
1 required
PromptAgentAPIModel-Input
object
20 properties
CustomLLM
object
7 properties
1 required
QueryParamsJsonSchema-Input
object
2 properties
1 required
EndProcedureToolResultSuccessModel
object
5 properties
2 required
UpdateAgentProcedureParams
object
1 property
CancelGroupSessionForAllParams
object
Cancel an entire group session and notify every registered participant. Destructive -- prefer cancelgroupsessionregistration for cancelling a single attendee.
1 property
TriggeredGuardrailCommonModel
object
2 properties
1 required
UpdateAgentRuleParams
object
1 property
ReferencedToolCommonModel
object
Reference to a tool for unit test evaluation.
2 properties
2 required
DeleteAgentProcedureParams
object
1 property
GuardrailType
string
UpdateResponseUnitTestRequest
object
11 properties
1 required
ListAgentReferencesParams
object
1 property
RagChunkMetadata
object
3 properties
3 required
DeleteTransferRuleParams
object
1 property
ToolCallUnitTestModel
object
8 properties
BackupLLMOverride
object
2 properties
1 required
KnowledgeBaseToolConfig
object
2 properties
WorkflowStandaloneAgentNodeModel-Input
object
9 properties
ResponseUnitTestModel
object
9 properties
WidgetExpandable
string
GetTestsPageResponseModel
object
3 properties
2 required
CreateServiceQuoteRequestParams
object
1 property
CreateAgentConversationTicketRequestModel
object
3 properties
1 required
SoftTimeoutConfigWorkflowOverride
object
8 properties
ToolCallSoundType
string
Predefined tool call sounds; None means no sound.
ConvAISecretLocator
object
Used to reference a secret from the agent's secret store.
1 property
1 required
ConversationConfigClientOverride-Input
object
5 properties
KnowledgeBaseToolInfo
object
1 property
LeaveMessageParams
object
1 property
SIPUriTransferDestination
object
2 properties
1 required
ResourceAccessInfo
object
6 properties
4 required
DeleteCalendarEventParams
object
Permanently remove a previously-cancelled calendar event. This delete tool is the irreversible follow-up to cancelcalendarevent. The backend rejects the call (…
1 property
ASRConversationalConfig
object
4 properties
TransferToNumberResultTwilioSuccessModel
object
9 properties
3 required
MetricRecord
object
1 property
1 required
KnowledgeBaseDocumentType
string
ConversationInitiationClientDataConfig-Input
object
5 properties
ResubmitTestsRequestModel
object
4 properties
2 required
EndCallToolResultModel
object
4 properties
ConversationHistoryTranscriptCommonModel-Output
object
23 properties
2 required
RagRetrievalInfo
object
5 properties
4 required
WidgetLanguagePreset
object
6 properties
AdhocAgentConfigOverrideForTestRequestModel
object
3 properties
2 required
CustomGuardrailConfig
object
Single custom guardrail configuration
9 properties
2 required
DeleteProductParams
object
1 property
Position-Input
object
2 properties
VADConfig
object
1 property
ASTDivisionOperatorNode-Input
object
3 properties
2 required
PrivacyConfig-Input
object
7 properties
ConversationalConfigAPIModelWorkflowOverride-Input
object
7 properties
WorkflowResultConditionModel-Input
object
3 properties
1 required
CheckServiceAvailabilityParams
object
1 property
TurnConfig
object
14 properties
EndProcedureToolConfig
object
2 properties
LLMInputOutputTokensUsage
object
4 properties
ApiIntegrationWebhookToolConfig-Input
object
18 properties
4 required
SoftTimeoutConfigOverride
object
2 properties
AgentCallLimits
object
3 properties
SearchStrategy
string
GuardrailExecutionMode
string
SMBToolConfig
object
SMB tool configuration that wraps SMB tool parameters.
15 properties
2 required
UnitTestToolCallParameter
object
2 properties
2 required
SetBookingSlugParams
object
1 property
TransferToNumberResultErrorModel
object
4 properties
1 required
BackgroundSoundConfigWorkflowOverride
object
4 properties
DeleteHolidayParams
object
1 property
TTSConversationalConfigWorkflowOverride-Input
object
14 properties
BuiltInToolsWorkflowOverride-Input
object
7 properties
ListHolidaysParams
object
1 property
ConfigEntityType
string
Entity types for the API configuration. This enum contains all valid entity type configurations that users can specify: - Parent types (e.g., "name", "financia…
ASTAndOperatorNode-Input
object
2 properties
1 required
CreateClientParams
object
Create a new client in the system.
1 property
AgentWorkspaceOverrides-Input
object
2 properties
ContentConfig
object
7 properties
WorkflowToolNestedToolsStepModel-Input
object
6 properties
5 required
ConversationInitiationClientDataWebhook
object
2 properties
2 required
TestToolResultModel
object
3 properties
GetClientAppointmentsParams
object
2 properties
CreateStaffParams
object
Create a new staff member in the system.
1 property
GetBookingSlugStatusParams
object
1 property
AlertingIntegrationNotifier
ConvAIWebhooks
object
4 properties
PydanticPronunciationDictionaryVersionLocator
object
A locator for other documents to be able to reference a specific dictionary and it's version. This is a pydantic version of PronunciationDictionaryVersionLocat…
2 properties
2 required
TestInvocationSummaryResponseModel
object
14 properties
7 required
ASRConversationalConfigOverride
object
1 property
WidgetTextContents
object
50 properties
AgentConversationTicketResponseModel
object
18 properties
18 required
ConversationTurnMetrics
object
4 properties
AssignableUserResponseModel
object
5 properties
5 required
GetToolCallUnitTestResponseModel
object
10 properties
2 required
PromptAgentAPIModelWorkflowOverride-Input
object
20 properties
FileInputConfig
object
3 properties
WidgetFeedbackMode
string
ListStaffParams
object
2 properties
EndProcedureToolResultErrorModel
object
4 properties
2 required
ConstantSchemaOverride
object
2 properties
1 required
ConversationHistoryTranscriptToolCallApiIntegrationWebhookDetails-Output
object
5 properties
5 required
BehaviorOverride
object
3 properties
LLMTokensCategoryUsage
object
2 properties
ListAssetsParams
object
2 properties
TurnEagerness
string
Agent's eagerness to respond. Higher values make agent wait for higher turn probability.
ASRConversationalConfigOverrideConfig
object
1 property
TurnMode
string
UpdateClientParams
object
Update an existing client's information.
1 property
PhoneNumberTransferDestination
object
2 properties
1 required
SystemToolConfig-Input
object
A system tool is a tool that is used to call a system method in the server
13 properties
2 required
GetTestInvocationsPageResponseModel
object
4 properties
2 required
EmbeddingModelEnum
string
ConversationReasoningModel
object
2 properties
ConversationHistoryTranscriptWorkflowToolsResultCommonModel-Input
object
12 properties
6 required
RegisterForGroupSessionParams
object
Register a client for a scheduled group session.
1 property
EntryBehavior
string
GetClientByPhoneParams
object
Look up a client by their exact phone number.
1 property
ListAgentRulesParams
object
1 property
StartProcedureToolErrorStatus
string
BackupLLMDisabled
object
1 property
WidgetTextContentsTranslation
object
2 properties
KnowledgeBaseRagToolConfig
object
1 property
PhoneNumberDynamicVariableTransferDestination
object
2 properties
1 required
AgentPlatformSettingsRequestModel
object
21 properties
ToolExecutionMode
string
LanguagePreset-Input
object
3 properties
1 required
EndCallToolConfig
object
1 property
SearchClientsParams
object
Search for clients by name, phone number, or email.
1 property
ToolType
string
SpellingPatience
string
Controls if the agent should be more patient when user is spelling numbers and named entities.
WidgetPlacement
string
PostDialDigitsStatic
object
2 properties
1 required
RegexParameterEvaluationStrategy
object
2 properties
2 required
AlertingPagerDutyNotifier
object
3 properties
1 required
WorkflowToolResponseModel-Output
object
A common model for workflow tool responses.
1 property
WidgetConfig-Input
object
49 properties
EnvironmentAuthConnectionLocator
object
References an environment variable of type 'authconnection' by label. At runtime, resolves to the auth connection for the current environment, falling back to…
1 property
1 required
CustomLLMAPIType
string
ConversationConfigWorkflowOverride-Input
object
9 properties
VADConfigWorkflowOverride
object
1 property
CreateToolCallUnitTestRequest
object
10 properties
1 required
ASRProvider
string
ResponseFilterMode
string
Controls how tool responses are filtered before being visible to the agent.
CreateLocationParams
object
1 property
ListClientInteractionsParams
object
1 property
LanguageDetectionToolConfig
object
2 properties
ChatSourceMedium
string
OptInSmsReminderParams
object
1 property
RunAgentTestsRequestModel
object
4 properties
1 required
LLMUsage-Output
object
1 property
RequiredConstraint
object
A set of fields that must all be present to satisfy this constraint.
1 property
1 required
WebhookTranscriptFormat
string
TransferBranchInfoDefaultingToMain
object
2 properties
2 required
CreateOrderParams
object
1 property
SimulationToolMockBehaviorConfig
object
Simulation/preview-side config: tools are identified by IDs, resolved to names at runtime.
3 properties
PostDialDigitsDynamicVariable
object
2 properties
1 required
TTSConversationalConfigOverride
object
7 properties
AgentConfigOverride-Input
object
4 properties
ASRConversationalConfigWorkflowOverride
object
4 properties
CustomSIPHeaderWithDynamicVariable
object
Custom SIP header for phone transfers with a dynamic variable reference. The value is a variable name that will be resolved at runtime. Value is not validated…
3 properties
3 required
DynamicVariableAssignment
object
Configuration for extracting values from tool responses and assigning them to dynamic variables.
5 properties
2 required
TransferToNumberResultSipSuccessModel
object
5 properties
1 required
UpdateCalendarEventParams
object
1 property
UpdateGroupSessionSeatsParams
object
Change the seat count of an existing group session registration.
1 property
DeleteAssetParams
object
1 property
TestSharingMode
string
UpdateProductParams
object
1 property
UpdateTransferRuleParams
object
2 properties
ConversationHistoryRedactionConfig
object
2 properties
PhoneNumberTransfer
object
8 properties
2 required
CancelOrderParams
object
1 property
KnowledgeBaseRagToolResultModel
object
5 properties
SuggestedAudioTag
object
2 properties
1 required
ASTAdditionOperatorNode-Input
object
3 properties
2 required
ASTOrOperatorNode-Input
object
2 properties
1 required
PatchAgentConversationTicketRequestModel
object
2 properties
UpdateAssetParams
object
1 property
AgentConfigAPIModelWorkflowOverride-Input
object
8 properties
LanguageDetectionToolResultModel
object
4 properties
EffectsSpec-Input
object
Filter preset, distance (proximity EQ), and environment (convolution reverb).
6 properties
MCPToolConfig-Input
object
An MCP tool configuration that can be used to call MCP servers
22 properties
7 required
LiteralJsonSchemaProperty
object
Schema property for literal JSON types. IMPORTANT: Only ONE of the following fields can be set: description (LLM provides value), dynamicvariable (value from v…
9 properties
1 required
GetBookingPageSettingsParams
object
1 property
TransferToAgentToolConfig-Input
object
2 properties
1 required
WidgetEndFeedbackType
string
UpdateLocationParams
object
1 property
ConversationHistoryTranscriptSystemToolResultCommonModel-Output
object
12 properties
6 required
EvaluationSuccessResult
string
ConversationHistoryMultivoiceMessageModel
object
Represents a message from a multi-voice agent.
1 property
1 required
LLMSchemaOverride
object
2 properties
TestRunResultBucket
object
4 properties
4 required
RetryTriggerAction
object
2 properties
AlertingSlackNotifier
object
4 properties
2 required
ContentGuardrail-Input
object
3 properties
ListCustomerFacingAgentsParams
object
List every customer-facing agent on the workspace. The assistant uses this whenever it needs to act on a specific customer-facing agent (rules, config edits, e…
1 property
DeleteServiceParams
object
Delete an existing service from the system.
1 property
URLAvatar
object
2 properties
ExactParameterEvaluationStrategy
object
2 properties
2 required
ResponseFilter
object
Configuration for filtering tool responses before they are visible to the agent.
3 properties
AnalysisScope
string
TestType
string
PlayDTMFResultErrorModel
object
4 properties
1 required
WorkflowToolEdgeStepModel
object
4 properties
3 required
UpdateCustomerFacingConfigParams
object
1 property
AgentSuccessfulResponseExample
object
2 properties
2 required
ASTEqualsOperatorNode-Input
object
3 properties
2 required
AgentTrustContext
string
The trust context in which the agent operates. UNKNOWN: not yet classified (existing agents created before this feature). LOW: serves untrusted external partic…
ModerationConfig
object
11 properties
UnitTestSummaryResponseModel
object
11 properties
5 required
LLMParameterEvaluationStrategy
object
2 properties
2 required
MatchAnythingParameterEvaluationStrategy
object
1 property
1 required
CriteriaScoringMode
string
ArrayJsonSchemaProperty-Input
object
7 properties
PromptAgentAPIModelOverride-Input
object
5 properties
SkipTurnToolConfig
object
Allows the agent to explicitly skip its turn. This tool should be invoked by the LLM when the user indicates they would like to think or take a short pause bef…
1 property
GetAnalyticsSummaryParams
object
Get a summary of key business analytics for a time period.
1 property
EndProcedureToolErrorStatus
string
SingleTestRunRequestModel
object
4 properties
1 required
CreateServiceParams
object
Create a new service (classic, rental, or group) in the system.
1 property
CustomGuardrail-Input
object
Container for custom guardrails, matching ModerationGuardrail pattern
1 property
OrbAvatar
object
3 properties
UpdateToolCallUnitTestRequest
object
10 properties
1 required
WorkflowToolLocator
object
2 properties
1 required
ScheduleGroupSessionParams
object
Schedule a single instance of a group service. The session's duration is derived from the parent service so the assistant only has to pin start time, the (opti…
1 property
ConversationHistoryTranscriptToolCallWebhookDetails
object
7 properties
2 required
CustomGuardrailsConfig-Input
object
Config container for custom guardrails list
1 property
ConversationHistoryTranscriptApiIntegrationWebhookToolsResultCommonModel-Output
object
14 properties
14 required
ValidationError
object
3 properties
3 required
LLM
string
TTSConversationalModel
string
TriggerUserVerificationParams
object
1 property
ConversationalConfigAPIModel-Input
object
7 properties
TestFromConversationMetadata-Output
object
5 properties
2 required
ToolResponseMockConfig-Input
object
3 properties
1 required
AllowlistItem
object
1 property
1 required
BackgroundSoundPresetId
string
Predefined background sound preset identifiers.
ASTBooleanNode-Input
object
2 properties
1 required
TransferBranchInfoTrafficSplit
object
3 properties
3 required
ListResponseMeta
object
3 properties
BackupLLMDefault
object
1 property
ValidateUserVerificationCodeParams
object
1 property
AttachedSystemDataCollectionRef
object
3 properties
2 required
ConversationConfigOverride
object
2 properties
AgentAnalysisItems-Input
object
2 properties
CreateAgentTestResponseModel
object
1 property
1 required
ConversationHistoryTranscriptToolCallClientDetails
object
2 properties
1 required
ProcedureVersionRef
object
2 properties
2 required
StartProcedureToolResultSuccessModel
object
7 properties
2 required
MockingStrategy
string
TopicDiscoverySettings
object
Per-agent topic-discovery configuration. Cadence and analysis window are managed internally; this only exposes the customer-facing on/off toggle.
ContentThresholdGuardrail
object
2 properties
CreateAgentRuleParams
object
1 property
WorkflowLLMConditionModel-Input
object
3 properties
1 required
WidgetEndFeedbackConfig
object
1 property
CreateProductQuoteRequestParams
object
1 property
SubmitBusinessInfoParams
object
Finalize the onboarding interview: create a text knowledge source and mark done.
1 property
CreateClientInteractionParams
object
1 property
DynamicVariablesConfigWorkflowOverride
object
1 property
LLMUsage-Input
object
1 property
AddTurnCommentRequestModel
object
2 properties
2 required
TransferToAgentToolResultSuccessModel-Output
object
11 properties
3 required
UnitTestToolCallEvaluationModel-Output
object
4 properties
CreateSimulationTestRequest
object
17 properties
1 required
SendCustomEmailParams
object
1 property
WorkflowToolNodeModel-Input
object
4 properties
ReportKnowledgeGapParams
object
1 property
ListTestsByIdsRequestModel
object
1 property
1 required
AnalysisProperty
object
Data collection property with optional per-item LLM override for post-call analysis. TODO: migrate to composition (valueschema: LiteralJsonSchemaProperty + llm…
11 properties
1 required
ConversationHistoryTranscriptToolCallMCPDetails
object
9 properties
4 required
WebhookToolConfig-Input
object
A webhook tool is a tool that calls an external webhook from our server
17 properties
3 required
TTSModelFamily
string
TurnCommentResponseModel
object
4 properties
4 required
TTSConversationalConfig-Input
object
14 properties
ListTransferRulesParams
object
1 property
GetTestsSummariesByIdsResponseModel
object
1 property
1 required
ConversationHistoryTranscriptToolCallApiIntegrationWebhookDetails-Input
object
5 properties
1 required
BucketingStatus
string
ListGroupSessionsParams
object
List scheduled group sessions for a group service in a date range. Group services are scheduled in advance (e.g. yoga classes, workshops) and callers register…
1 property
ASTStringNode-Input
object
2 properties
1 required
DynamicVariablesConfig
object
1 property
ASTLLMNode-Input
AgentConversationTicketStatus
string
CancelGroupSessionRegistrationParams
object
Cancel a single client's registration for a group session.
1 property
DynamicVariableSchemaOverride
object
2 properties
1 required
AgentConversationTicketSource
string
UserFeedbackScore
string
AllowedValues
object
1 property
1 required
AgentConfigAPIModel-Input
object
8 properties
UpdateBusinessInfoParams
object
1 property
ConversationConfigClientOverrideConfig-Input
object
5 properties
AttachedTestModel
object
2 properties
1 required
CustomSIPHeader
object
Custom SIP header for phone transfers with a static (validated) value.
3 properties
2 required
AlertingMonitorConfig
object
7 properties
WebhookEventType
string
ToolInterruptionMode
string
WorkflowToolNestedToolsStepModel-Output
object
6 properties
5 required
ConversationHistoryTranscriptToolCallCommonModel-Input
object
6 properties
4 required
CreateManualTicketRequestModel
object
1 property
1 required
GetOrderByConfirmationNumberParams
object
1 property
WorkflowEdgeModel-Input
object
4 properties
2 required
WorkflowUnconditionalModel-Input
object
2 properties
DummyToolResultModel
object
1 property
DeleteAgentRuleParams
object
1 property
ASTConditionalOperatorNode-Input
object
4 properties
3 required
TestRunResultSummary
object
4 properties
3 required
Verbosity
string
TurnConfigOverrideConfig
object
1 property
HTTPValidationError
object
1 property
ConversationHistoryTranscriptToolCallCommonModel-Output
object
6 properties
4 required
DeleteClientInteractionParams
object
1 property
GetClientOrdersParams
object
2 properties
ApiIntegrationWebhookOverrides
object
4 properties
GetResponseUnitTestResponseModel
object
11 properties
2 required
DocumentUsageModeEnum
string
ASTGreaterThanOperatorNode-Input
object
3 properties
2 required
ConversationHistoryTranscriptWorkflowToolsResultCommonModel-Output
object
12 properties
6 required
ASRQuality
string
WidgetTermsTranslation
object
2 properties
2 required
StartProcedureToolConfig
object
2 properties
AgentQueueingConfig
object
3 properties
WorkflowPhoneNumberNodeModel-Input
object
9 properties
1 required
WebhookToolApiSchemaConfig-Input
object
11 properties
1 required
SoftTimeoutConfig
object
Configuration for soft timeout functionality during LLM response generation.
8 properties
ProcedureDraftRef
object
2 properties
1 required
IntegrationType
string
AgentFailureResponseExample
object
2 properties
2 required
AuthSettings
object
4 properties
ToolCallSoundBehavior
string
Determines how the tool call sound should be played.
ConvAIDynamicVariable
object
Used to reference a dynamic variable.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ElevenLabs 12
Other APIs ElevenLabs publishes across the network.
elevenlabs Agents API
elevenlabs Audio Isolation API
elevenlabs Audio Native API
elevenlabs Conversations API
elevenlabs Dubbing API
elevenlabs Dubbing Resources API
elevenlabs Instant Voice Cloning API
elevenlabs Knowledge Base API
elevenlabs Music Generation API
elevenlabs Professional Voice Cloning API
elevenlabs Speech to Speech API
elevenlabs Speech to Text API
#Convai
Where this information came from
This is an independent, third-party profile of ElevenLabs Convai API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.