API referenceConversations

Get signed URL

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

Headers

xi-api-keystringRequired

Query parameters

agent_idstringRequired
The id of the agent you're taking the action on.
include_conversation_idbooleanOptionalDefaults to false

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

branch_idstring or nullOptional
The ID of the branch to use
environmentstring or nullOptional

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

Response

Successful Response
signed_urlstring

Errors

422
Unprocessable Entity Error