Skip to main content
GET
Get Agent
Retrieve a voice agent’s published configuration.

Authentication

string
requerido
Organization API key. Keep it on your server or in a credential store.

Path

string
requerido
Agent ID from the organization’s agent list.

Example

Response

number
HTTP response status.
string
ContactShip agent ID, used in agent and call endpoints.
string
Internal name.
string
In-call name.
string
Instructions.
string
Conversation objective.
string
Voice ID.
string
Configured language code.
string
IANA time zone.
object[]
Configured tool definitions.
object[]
Extraction fields.
string
Outgoing call webhook URL.
string
Creation timestamp.
string
Update timestamp.
The response also includes configured voice/conversation values such as volume, voice_speed, voice_temperature, responsiveness, interruption_sensitivity, ambient_sound, ambient_sound_volume, begin_message, begin_message_delay_ms, max_call_duration_ms, start_speaker, and boosted_keywords.