Headers
API key for authentication
Path Parameters
The ID of the agent to retrieve
Response
Agent retrieved successfully
The response is of type object
.
curl --request GET \
--url https://api.contactship.ai/v1/agents/{agentId} \
--header 'x-api-key: <x-api-key>'
{
"statusCode": 200,
"data": {
"id": "337a9eeb-3e16-4cc5-94ec-25fa159eb57a",
"name": "Enterprise Sales Agent",
"person_name": "James Wilson",
"language": "en-US",
"webhook_url": "https://webhook.example.com/enterprise-sales",
"conversation_purpose": "Qualify enterprise leads and schedule product demonstrations",
"prompt": "You are James Wilson, an experienced enterprise sales representative. Your goal is to understand potential customers' business needs and demonstrate how our solutions can help them scale. Focus on building rapport and identifying key decision-makers.\n\nKey points to remember:\n- Ask about their current business challenges\n- Explain our enterprise solutions clearly\n- Highlight relevant case studies\n- Schedule demos with qualified leads\n\nMaintain a professional yet friendly tone, and always follow up on specific industry requirements.",
"volume": 1.1,
"voice_id": "custom_voice_james_enterprise",
"interruption_sensitivity": 0.85,
"ambient_sound": "office",
"voice_speed": 0.95,
"voice_temperature": 0.7,
"post_call_analysis_data": [
{
"name": "company_size",
"type": "string",
"description": "Size category of the prospect company"
},
{
"name": "budget_range",
"type": "string",
"description": "Estimated budget range for the solution"
}
],
"tools": [
{
"name": "schedule_enterprise_demo",
"type": "function",
"description": "Schedule a product demonstration for enterprise clients"
},
{
"name": "access_case_studies",
"type": "function",
"description": "Retrieve relevant case studies by industry"
}
],
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-03-20T15:45:00.000Z"
}
}
Get a specific agent by ID
curl --request GET \
--url https://api.contactship.ai/v1/agents/{agentId} \
--header 'x-api-key: <x-api-key>'
{
"statusCode": 200,
"data": {
"id": "337a9eeb-3e16-4cc5-94ec-25fa159eb57a",
"name": "Enterprise Sales Agent",
"person_name": "James Wilson",
"language": "en-US",
"webhook_url": "https://webhook.example.com/enterprise-sales",
"conversation_purpose": "Qualify enterprise leads and schedule product demonstrations",
"prompt": "You are James Wilson, an experienced enterprise sales representative. Your goal is to understand potential customers' business needs and demonstrate how our solutions can help them scale. Focus on building rapport and identifying key decision-makers.\n\nKey points to remember:\n- Ask about their current business challenges\n- Explain our enterprise solutions clearly\n- Highlight relevant case studies\n- Schedule demos with qualified leads\n\nMaintain a professional yet friendly tone, and always follow up on specific industry requirements.",
"volume": 1.1,
"voice_id": "custom_voice_james_enterprise",
"interruption_sensitivity": 0.85,
"ambient_sound": "office",
"voice_speed": 0.95,
"voice_temperature": 0.7,
"post_call_analysis_data": [
{
"name": "company_size",
"type": "string",
"description": "Size category of the prospect company"
},
{
"name": "budget_range",
"type": "string",
"description": "Estimated budget range for the solution"
}
],
"tools": [
{
"name": "schedule_enterprise_demo",
"type": "function",
"description": "Schedule a product demonstration for enterprise clients"
},
{
"name": "access_case_studies",
"type": "function",
"description": "Retrieve relevant case studies by industry"
}
],
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-03-20T15:45:00.000Z"
}
}
API key for authentication
The ID of the agent to retrieve
Agent retrieved successfully
The response is of type object
.