curl --request GET \
--url https://api.contactship.ai/v1/agents \
--header 'x-api-key: <x-api-key>'{
"statusCode": 123,
"data": [
{
"id": "<string>",
"name": "<string>",
"language": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"person_name": "<string>",
"webhook_url": "<string>",
"conversation_purpose": "<string>",
"prompt": "<string>",
"volume": 123,
"voice_id": "<string>",
"interruption_sensitivity": 123,
"ambient_sound": "<string>",
"voice_speed": 123,
"voice_temperature": 123,
"post_call_analysis_data": [
{}
],
"tools": [
{}
],
"updated_at": "2023-11-07T05:31:56Z"
}
]
}Returns all agents from the system that the user has access to
curl --request GET \
--url https://api.contactship.ai/v1/agents \
--header 'x-api-key: <x-api-key>'{
"statusCode": 123,
"data": [
{
"id": "<string>",
"name": "<string>",
"language": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"person_name": "<string>",
"webhook_url": "<string>",
"conversation_purpose": "<string>",
"prompt": "<string>",
"volume": 123,
"voice_id": "<string>",
"interruption_sensitivity": 123,
"ambient_sound": "<string>",
"voice_speed": 123,
"voice_temperature": 123,
"post_call_analysis_data": [
{}
],
"tools": [
{}
],
"updated_at": "2023-11-07T05:31:56Z"
}
]
}API key for authentication
Agents retrieved successfully
HTTP status code
Show child attributes
The ID of the agent
The name of the agent in our system
The language of the agent
The creation time of the agent
The name of the agent in the call
The webhook URL for call status updates
The purpose of the conversation
The prompt for the agent
Volume level for the voice
The ID of the voice to use
Sensitivity level for interruptions (0-1)
Background sound configuration
Speed of the voice
Temperature parameter for voice generation
Configuration for post-call analysis
List of tools available to the agent
The last update time of the agent