Skip to main content
GET
/
v1
/
agents
/
{agentId}
cURL
curl --request GET \
  --url https://api.contactship.ai/v1/agents/{agentId} \
  --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"
  }
}

Headers

x-api-key
string
required

API key for authentication

Path Parameters

agentId
string
required

The ID of the agent to retrieve

Response

Agent retrieved successfully

statusCode
integer

HTTP status code

data
object