Get agent by ID | Atlas | Documentation

curl https://api.youratlas.com/v1/api/agent/campaignId/id \
     -H "api-key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "Name": "Sophia",
  "Language": "en-US",
  "VoiceId": "en-US-Wavenet-D",
  "AgentTypeName": "Customer Support",
  "PreScript": "Hello, thank you for calling. How can I assist you today?",
  "PostScript": "Thank you for your time. Have a great day!",
  "AtlasVoiceId": "atlas-voice-1234",
  "Model": "neural-v1",
  "Provider": "11labs",
  "Stability": 0.85,
  "SimilarityBoost": 0.9,
  "BackgroundSound": "office-ambient",
  "Pitch": 1,
  "Speed": 1.05,
  "Region": "us-east-1",
  "Volume": 0.95,
  "LanguageBoost": "en",
  "FillerInjectionEnabled": true,
  "TextNormalizationEnabled": true,
  "PartitionKey": "campaign-7890",
  "RowKey": "agent-4567",
  "Timestamp": "2024-01-15T09:30:00Z"
}

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

campaignIdstringRequired

idstringRequired

Response

Successful response

Namestring

Languagestring

VoiceIdstring

AgentTypeNamestring

PreScriptstring

PostScriptstring

AtlasVoiceIdstring

Modelstring

Providerenum

Allowed values:

Stabilitydouble

SimilarityBoostdouble

BackgroundSoundstring

Pitchdouble

Speeddouble

Regionstring

Volumedouble

LanguageBooststring

FillerInjectionEnabledboolean

TextNormalizationEnabledboolean

PartitionKeystring

RowKeystring

Timestampdatetime

Errors

404

Not Found Error

500

Internal Server Error