Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Get Signed Url

Get a signed url to start a conversation with an agent with an agent that requires authorization

get/v1/convai/conversation/get-signed-url

Query parameters

agent_idstring required

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

include_conversation_idboolean

Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again.

Whether to include a conversation_id with the response. If included, the conversation_signature cannot be used again.

branch_idstring nullable

The ID of the branch to use

The ID of the branch to use

environmentstring nullable

The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to 'production'.

The environment to use for resolving environment variables (e.g. 'production', 'staging'). Defaults to 'production'.

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.

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.

Response

Successful Response

signed_urlstring required