Personalised greetings. The first variant whose conditions all match the
caller wins; otherwise greeting is spoken. A variant is only spoken when
every placeholder in it has a value.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"TalkPilot","colors":{"primary":"#F97316","light":"#FB923C","dark":"#EA580C"},"favicon":"https://mintcdn.com/talkpilot-8db57f17/MqDjkG0yYrs67v1D/favicon.png?fit=max\u0026auto=format\u0026n=MqDjkG0yYrs67v1D\u0026q=85\u0026s=d074cec1c25b16ec2a71f2adeb67e60e","api":{"openapi":["openapi.yaml"]},"navbar":{"links":[{"href":"mailto:support@talkpilot.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.talkpilot.io"}},"footer":{"socials":{"website":"https://talkpilot.io"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api/agents"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"talkpilot-8db57f17","hasAudioNarration":false,"actualSubdomain":"talkpilot-8db57f17","customDomains":["docs.talkpilot.io"],"gitSource":{"type":"github","owner":"wcmrg77","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4c9f4c97cf9d1412c6fda","collectionId":"2c6c4323-c31d-4fc1-85ef-7c14f0a1f770","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4c9f4c97cf9d1412c6fda"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae4c9f4c97cf9d1412c6fda","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Endpoint Reference","count":48},{"language":"default","tag":"Documentation","count":22},{"language":"default","tag":"Product Guide","count":16},{"language":"default","tag":"API Resources","count":11},{"language":"default","tag":"Knowledge Base","count":8},{"language":"default","tag":"Agents","count":7},{"language":"default","tag":"Contacts","count":5},{"language":"default","tag":"Employees","count":5},{"language":"default","tag":"Forwarding Slots","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/agents/get-agent-details","slug":"/api-reference/agents/get-agent-details","pageMetadata":{"openapi":"get /v1/agents/{agentId}","title":"Get agent details","description":"Returns the full configuration of a single agent.","href":"/api-reference/agents/get-agent-details"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns the full configuration of a single agent.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v1/agents/{agentId}","title":"Get agent details","description":"Returns the full configuration of a single agent.","href":"/api-reference/agents/get-agent-details"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAgent","tags":["Agents"],"summary":"Get agent details","description":"Returns the full configuration of a single agent.","parameters":["8dc5aaa6-7c9c-4ed5-a2d5-1ebdc861d3bd"],"responses":{"200":"b355cde4-394b-4930-8423-41f1a4418427","401":"0512adf7-90cb-498c-ac6c-0e92783aadc4","403":"be0c4062-eac6-485b-ac91-8d5d0982f822","404":"8ebf2338-03c2-444f-bd6d-06cf3c46b4c5","429":"5a25206c-98cb-4495-ad36-4bbc65d1f148"},"method":"get","type":"path","servers":["7174c07b-3f6d-4587-860c-b159b3fceb86"],"security":["daeed687-106f-4e81-b970-a2ffa4b47569"],"path":"/v1/agents/{agentId}","baseUrlOptions":["https://api.talkpilot.io"],"title":"Get agent details","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8dc5aaa6-7c9c-4ed5-a2d5-1ebdc861d3bd":{"name":"agentId","in":"path","required":true,"description":"Agent UUID","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Agent UUID","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"b355cde4-394b-4930-8423-41f1a4418427":{"description":"Agent details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"organization_id":{"type":"string","format":"uuid","readOnly":true,"uniqueKey":"organization_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"phone_number":{"type":"string","uniqueKey":"phone_number","typeLabel":"string"},"is_active":{"type":"boolean","uniqueKey":"is_active","typeLabel":"boolean"},"language":{"oneOf":[{"type":"string","description":"Language code: de, en, fr, es","uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","description":"Language code: de, en, fr, es","uniqueKey":"language.oneOf.1","typeLabel":"null"}],"uniqueKey":"language","typeLabel":"string | null"},"formality":{"oneOf":[{"type":"string","enum":["formal","informal"],"description":"formal = Sie, informal = Du","uniqueKey":"formality.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["formal","informal"],"description":"formal = Sie, informal = Du","uniqueKey":"formality.oneOf.1","typeLabel":"null"}],"uniqueKey":"formality","typeLabel":"enum\u003cstring> | null"},"llm_provider":{"oneOf":[{"type":"string","enum":["azure","openai","gemini","gemini_live","gemini_live_cascade","openai_realtime","openai_realtime_cascade","groq"],"uniqueKey":"llm_provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["azure","openai","gemini","gemini_live","gemini_live_cascade","openai_realtime","openai_realtime_cascade","groq"],"uniqueKey":"llm_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"llm_provider","typeLabel":"enum\u003cstring> | null"},"llm_model":{"oneOf":[{"type":"string","description":"Model identifier, e.g. gpt-4.1, gemini-2.5-flash, meta-llama/llama-4-scout-17b-16e-instruct, llama-3.3-70b-versatile, llama-3.1-8b-instant","uniqueKey":"llm_model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Model identifier, e.g. gpt-4.1, gemini-2.5-flash, meta-llama/llama-4-scout-17b-16e-instruct, llama-3.3-70b-versatile, llama-3.1-8b-instant","uniqueKey":"llm_model.oneOf.1","typeLabel":"null"}],"uniqueKey":"llm_model","typeLabel":"string | null"},"llm_temperature":{"oneOf":[{"type":"number","minimum":0,"maximum":2,"uniqueKey":"llm_temperature.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":2,"uniqueKey":"llm_temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"llm_temperature","typeLabel":"number | null"},"tts_provider":{"oneOf":[{"type":"string","enum":["cartesia","elevenlabs","gemini_live","openai_realtime"],"uniqueKey":"tts_provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["cartesia","elevenlabs","gemini_live","openai_realtime"],"uniqueKey":"tts_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"tts_provider","typeLabel":"enum\u003cstring> | null"},"voice_id":{"oneOf":[{"type":"string","description":"Voice identifier for TTS","uniqueKey":"voice_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Voice identifier for TTS","uniqueKey":"voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_id","typeLabel":"string | null"},"realtime_voice":{"oneOf":[{"type":"string","description":"Voice for native realtime providers (OpenAI/Gemini)","uniqueKey":"realtime_voice.oneOf.0","typeLabel":"string"},{"type":"null","description":"Voice for native realtime providers (OpenAI/Gemini)","uniqueKey":"realtime_voice.oneOf.1","typeLabel":"null"}],"uniqueKey":"realtime_voice","typeLabel":"string | null"},"speaking_rate":{"oneOf":[{"type":"number","minimum":0.5,"maximum":2,"uniqueKey":"speaking_rate.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.5,"maximum":2,"uniqueKey":"speaking_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"speaking_rate","typeLabel":"number | null"},"stt_provider":{"oneOf":[{"type":"string","enum":["soniox","flux","deepgram","elevenlabs","mistral","groq","assemblyai","cartesia"],"description":"Speech-to-text provider (null for native realtime). `soniox` is the default for new agents, `flux` is Deepgram Flux, `deepgram` is Deepgram Nova-3.","uniqueKey":"stt_provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["soniox","flux","deepgram","elevenlabs","mistral","groq","assemblyai","cartesia"],"description":"Speech-to-text provider (null for native realtime). `soniox` is the default for new agents, `flux` is Deepgram Flux, `deepgram` is Deepgram Nova-3.","uniqueKey":"stt_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"stt_provider","typeLabel":"enum\u003cstring> | null"},"stt_keywords":{"oneOf":[{"type":"array","maxItems":100,"items":{"type":"string","uniqueKey":"stt_keywords.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Words the speech recognizer should prefer (names, products); max 100","uniqueKey":"stt_keywords.oneOf.0","typeLabel":"string[]"},{"type":"null","maxItems":100,"items":{"type":"string"},"description":"Words the speech recognizer should prefer (names, products); max 100","uniqueKey":"stt_keywords.oneOf.1","typeLabel":"null"}],"uniqueKey":"stt_keywords","typeLabel":"string[] | null"},"prompt":{"type":"string","description":"System prompt for the agent","maxLength":50000,"uniqueKey":"prompt","typeLabel":"string"},"greeting":{"oneOf":[{"type":"string","description":"Initial greeting message when call starts","maxLength":2000,"uniqueKey":"greeting.oneOf.0","typeLabel":"string"},{"type":"null","description":"Initial greeting message when call starts","maxLength":2000,"uniqueKey":"greeting.oneOf.1","typeLabel":"null"}],"uniqueKey":"greeting","typeLabel":"string | null"},"greeting_variants":{"oneOf":[{"type":"array","items":{"type":"object","required":["greeting"],"description":"Needs `greeting` plus at least one condition (`tag` or `tags`, a time window\n`from`+`to`, or `min_calls_today`). Several conditions are combined with AND; the\norder of the variants is the priority — if a contact carries tags of several\nvariants, the topmost matching variant wins. Use either `tag` or `tags`, not both.\nUnknown keys are rejected.\n","properties":{"greeting":{"type":"string","description":"May use {{vorname}}, {{nachname}}, {{anrede}} (from the contact) and pre-call webhook variables","isRequired":true,"uniqueKey":"greeting_variants.oneOf.0.items.[INDEX].greeting","typeLabel":"string"},"tag":{"type":"string","description":"A tag of the caller's contact (customer database), compared case-insensitively","uniqueKey":"greeting_variants.oneOf.0.items.[INDEX].tag","typeLabel":"string"},"tags":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":1,"uniqueKey":"greeting_variants.oneOf.0.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"description":"Several contact tags; any one of them is enough (OR), compared case-insensitively. Alternative to `tag`","uniqueKey":"greeting_variants.oneOf.0.items.[INDEX].tags","typeLabel":"string[]"},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"Start of the time window, HH:MM Europe/Berlin (inclusive). Requires `to`","uniqueKey":"greeting_variants.oneOf.0.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"End of the time window (exclusive). `from` > `to` wraps past midnight","uniqueKey":"greeting_variants.oneOf.0.items.[INDEX].to","typeLabel":"string"},"min_calls_today":{"type":"integer","minimum":1,"description":"Caller has already called at least this many times today","uniqueKey":"greeting_variants.oneOf.0.items.[INDEX].min_calls_today","typeLabel":"integer"}},"uniqueKey":"greeting_variants.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Personalised greetings. The first variant whose conditions all match the\ncaller wins; otherwise `greeting` is spoken. A variant is only spoken when\nevery placeholder in it has a value.\n","uniqueKey":"greeting_variants.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["greeting"],"description":"Needs `greeting` plus at least one condition (`tag` or `tags`, a time window\n`from`+`to`, or `min_calls_today`). Several conditions are combined with AND; the\norder of the variants is the priority — if a contact carries tags of several\nvariants, the topmost matching variant wins. Use either `tag` or `tags`, not both.\nUnknown keys are rejected.\n","properties":{"greeting":{"type":"string","description":"May use {{vorname}}, {{nachname}}, {{anrede}} (from the contact) and pre-call webhook variables"},"tag":{"type":"string","description":"A tag of the caller's contact (customer database), compared case-insensitively"},"tags":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":1},"description":"Several contact tags; any one of them is enough (OR), compared case-insensitively. Alternative to `tag`"},"from":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"Start of the time window, HH:MM Europe/Berlin (inclusive). Requires `to`"},"to":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"End of the time window (exclusive). `from` > `to` wraps past midnight"},"min_calls_today":{"type":"integer","minimum":1,"description":"Caller has already called at least this many times today"}}},"description":"Personalised greetings. The first variant whose conditions all match the\ncaller wins; otherwise `greeting` is spoken. A variant is only spoken when\nevery placeholder in it has a value.\n","uniqueKey":"greeting_variants.oneOf.1","typeLabel":"null"}],"uniqueKey":"greeting_variants","typeLabel":"object[] | null"},"post_call_webhook_url":{"oneOf":[{"type":"string","format":"uri","description":"Webhook URL called after each call completes","uniqueKey":"post_call_webhook_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Webhook URL called after each call completes","uniqueKey":"post_call_webhook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"post_call_webhook_url","typeLabel":"string\u003curi> | null"},"schedule":{"oneOf":[{"type":"object","description":"Agent business hours. When set, the agent only accepts calls during\nthe specified time windows. Outside hours, calls go to the backup agent.\n","properties":{"timezone":{"type":"string","description":"IANA timezone identifier","example":"Europe/Berlin","uniqueKey":"schedule.oneOf.0.timezone","typeLabel":"string"},"rules":{"type":"array","items":{"type":"object","required":["days","start_time","end_time"],"properties":{"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].days.items.[INDEX]","typeLabel":"integer"},"description":"Days of week (0=Sunday, 1=Monday, ..., 6=Saturday)","example":[1,2,3,4,5],"isRequired":true,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].days","typeLabel":"integer[]"},"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"Start time in HH:mm","example":"08:00","isRequired":true,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].start_time","typeLabel":"string"},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"End time in HH:mm","example":"18:00","isRequired":true,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].end_time","typeLabel":"string"}},"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"schedule.oneOf.0.rules","typeLabel":"object[]"}},"uniqueKey":"schedule.oneOf.0","typeLabel":"object"},{"type":"null","description":"Agent business hours. When set, the agent only accepts calls during\nthe specified time windows. Outside hours, calls go to the backup agent.\n","properties":{"timezone":{"type":"string","description":"IANA timezone identifier","example":"Europe/Berlin"},"rules":{"type":"array","items":{"type":"object","required":["days","start_time","end_time"],"properties":{"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6},"description":"Days of week (0=Sunday, 1=Monday, ..., 6=Saturday)","example":[1,2,3,4,5]},"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"Start time in HH:mm","example":"08:00"},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"End time in HH:mm","example":"18:00"}}}}},"uniqueKey":"schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule","typeLabel":"object | null"},"backup_agent_id":{"oneOf":[{"type":"string","format":"uuid","description":"Fallback agent when outside the schedule","uniqueKey":"backup_agent_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Fallback agent when outside the schedule","uniqueKey":"backup_agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"backup_agent_id","typeLabel":"string\u003cuuid> | null"},"allow_greeting_interruption":{"oneOf":[{"type":"boolean","description":"Allow callers to interrupt the greeting","uniqueKey":"allow_greeting_interruption.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Allow callers to interrupt the greeting","uniqueKey":"allow_greeting_interruption.oneOf.1","typeLabel":"null"}],"uniqueKey":"allow_greeting_interruption","typeLabel":"boolean | null"},"short_calls_auto_edit":{"type":"boolean","description":"Automatically mark very short calls as done","uniqueKey":"short_calls_auto_edit","typeLabel":"boolean"},"track_caller_name":{"type":"boolean","description":"Ask for and track the caller's name","uniqueKey":"track_caller_name","typeLabel":"boolean"},"transfer_timeout_seconds":{"oneOf":[{"type":"integer","minimum":5,"maximum":45,"description":"Timeout in seconds for call transfers (5-45)","uniqueKey":"transfer_timeout_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":5,"maximum":45,"description":"Timeout in seconds for call transfers (5-45)","uniqueKey":"transfer_timeout_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"transfer_timeout_seconds","typeLabel":"integer | null"},"bundesland":{"type":"string","enum":["DE","BW","BY","BE","BB","HB","HH","HE","MV","NI","NW","NRW","RP","SL","SN","ST","SH","TH"],"description":"German state for public-holiday handling; DE = nationwide holidays only","uniqueKey":"bundesland","typeLabel":"enum\u003cstring>"},"background_audio_enabled":{"type":"boolean","description":"Play ambient background audio during the call","uniqueKey":"background_audio_enabled","typeLabel":"boolean"},"background_audio_type":{"type":"string","enum":["office","cafe","home_office"],"uniqueKey":"background_audio_type","typeLabel":"enum\u003cstring>"},"background_audio_volume":{"type":"number","minimum":0,"maximum":1,"uniqueKey":"background_audio_volume","typeLabel":"number"},"thinking_sound_enabled":{"type":"boolean","description":"Play a subtle sound while the agent waits for the LLM","uniqueKey":"thinking_sound_enabled","typeLabel":"boolean"},"thinking_sound_volume":{"type":"number","minimum":0,"maximum":1,"uniqueKey":"thinking_sound_volume","typeLabel":"number"},"aic_enhancement_enabled":{"type":"boolean","description":"On-device voice-focus enhancement (ai-coustics) before speech recognition","uniqueKey":"aic_enhancement_enabled","typeLabel":"boolean"},"retention_days":{"oneOf":[{"type":"integer","readOnly":true,"description":"GDPR retention of call data in days (null = default 90). Managed in the Dashboard","uniqueKey":"retention_days.oneOf.0","typeLabel":"integer"},{"type":"null","readOnly":true,"description":"GDPR retention of call data in days (null = default 90). Managed in the Dashboard","uniqueKey":"retention_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"retention_days","typeLabel":"integer | null"},"metadata":{"oneOf":[{"type":"object","readOnly":true,"description":"Provider-specific tuning (e.g. Flux/EOU settings). Managed in the Dashboard","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","readOnly":true,"description":"Provider-specific tuning (e.g. Flux/EOU settings). Managed in the Dashboard","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Rezeption Bot","phone_number":"+4930123456","is_active":true,"language":"de","formality":"formal","llm_provider":"openai","llm_model":"gpt-4.1","llm_temperature":0.7,"tts_provider":"cartesia","voice_id":"sarah","realtime_voice":null,"speaking_rate":1,"stt_provider":"deepgram","prompt":"Du bist ein freundlicher Rezeptionsbot...","greeting":"Guten Tag, wie kann ich Ihnen helfen?","post_call_webhook_url":"https://example.com/webhook","schedule":{"timezone":"Europe/Berlin","rules":[{"days":[1,2,3,4,5],"start_time":"08:00","end_time":"18:00"}]},"backup_agent_id":null,"allow_greeting_interruption":true,"short_calls_auto_edit":false,"track_caller_name":true,"transfer_timeout_seconds":30,"created_at":"2025-06-01T10:00:00Z","updated_at":"2025-06-15T14:30:00Z"},"examples":{"Example":{"title":"Example","value":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Rezeption Bot","phone_number":"+4930123456","is_active":true,"language":"de","formality":"formal","llm_provider":"openai","llm_model":"gpt-4.1","llm_temperature":0.7,"tts_provider":"cartesia","voice_id":"sarah","realtime_voice":null,"speaking_rate":1,"stt_provider":"deepgram","prompt":"Du bist ein freundlicher Rezeptionsbot...","greeting":"Guten Tag, wie kann ich Ihnen helfen?","post_call_webhook_url":"https://example.com/webhook","schedule":{"timezone":"Europe/Berlin","rules":[{"days":[1,2,3,4,5],"start_time":"08:00","end_time":"18:00"}]},"backup_agent_id":null,"allow_greeting_interruption":true,"short_calls_auto_edit":false,"track_caller_name":true,"transfer_timeout_seconds":30,"created_at":"2025-06-01T10:00:00Z","updated_at":"2025-06-15T14:30:00Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"0512adf7-90cb-498c-ac6c-0e92783aadc4":{"description":"Missing or invalid authentication","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"Invalid or missing API key","request_id":"req_abc123"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"Invalid or missing API key","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"},"be0c4062-eac6-485b-ac91-8d5d0982f822":{"description":"Insufficient permissions (`FORBIDDEN`), or the agent is outside the key's\n`allowed_agent_ids` (`AGENT_NOT_ACCESSIBLE`)\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingPermission":{"title":"missingPermission","value":{"error":{"code":"FORBIDDEN","message":"API key lacks required permission: agents:write","request_id":"req_abc123"}}},"agentNotAccessible":{"title":"agentNotAccessible","value":{"error":{"code":"AGENT_NOT_ACCESSIBLE","message":"API key does not have access to this agent","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"},"8ebf2338-03c2-444f-bd6d-06cf3c46b4c5":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_FOUND","message":"Agent not found","request_id":"req_abc123"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Agent not found","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"},"5a25206c-98cb-4495-ad36-4bbc65d1f148":{"description":"Too many requests for this API key (60/minute or 1,000/hour by default)","headers":{"Retry-After":{"description":"Seconds to wait before retrying — 60 for the minute window, 3600 for the hour window","schema":{"type":"integer"}},"X-RateLimit-Limit":{"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Try again in 60 seconds.","request_id":"req_abc123"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Try again in 60 seconds.","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"daeed687-106f-4e81-b970-a2ffa4b47569":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for external access. Format: `tp_live_\u003c32-hex-chars>`.\nCreate keys in the TalkPilot Dashboard under Settings > API.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"7174c07b-3f6d-4587-860c-b159b3fceb86":{"url":"https://api.talkpilot.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for external access. Format: `tp_live_\u003c32-hex-chars>`.\nCreate keys in the TalkPilot Dashboard under Settings > API.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","description":"API key for external access. Format: `tp_live_\u003c32-hex-chars>`.\nCreate keys in the TalkPilot Dashboard under Settings > API.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"talkpilot-8db57f17","siteName":"TalkPilot","title":"Get agent details - TalkPilot","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-07T14:45:43.995Z","originalFileLocation":"api-reference/agents/get-agent-details.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the full configuration of a single agent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"TalkPilot\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get agent details - TalkPilot\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the full configuration of a single agent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TalkPilot\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.talkpilot.io/api-reference/agents/get-agent-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://talkpilot-8db57f17.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+agent+details\u0026amp;description=Returns+the+full+configuration+of+a+single+agent.\u0026amp;theme=91659bae7c7a4489b0dcb7f9\u0026amp;signature=0a65c79976d70db596d271966da9ca927baf54aca6cc95e65276ff759b824176\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get agent details - TalkPilot\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the full configuration of a single agent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://talkpilot-8db57f17.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+agent+details\u0026amp;description=Returns+the+full+configuration+of+a+single+agent.\u0026amp;theme=91659bae7c7a4489b0dcb7f9\u0026amp;signature=0a65c79976d70db596d271966da9ca927baf54aca6cc95e65276ff759b824176\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TalkPilot\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F97316\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.talkpilot.io/api-reference/agents/get-agent-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/get-agent-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.talkpilot.io/#organization\",\"name\":\"TalkPilot\",\"url\":\"https://docs.talkpilot.io\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.talkpilot.io#website\",\"name\":\"TalkPilot\",\"url\":\"https://docs.talkpilot.io\",\"publisher\":{\"@id\":\"https://docs.talkpilot.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details#webpage\",\"url\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details\",\"name\":\"Get agent details\",\"description\":\"Returns the full configuration of a single agent.\",\"dateModified\":\"2026-09-07T14:45:43.995Z\",\"isPartOf\":{\"@id\":\"https://docs.talkpilot.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoint Reference\",\"item\":\"https://docs.talkpilot.io/api-reference/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.talkpilot.io/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get agent details\",\"item\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details#apireference\",\"headline\":\"Get agent details\",\"name\":\"Get agent details\",\"description\":\"Returns the full configuration of a single agent.\",\"url\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details\",\"mainEntityOfPage\":{\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-details#webpage\"},\"dateModified\":\"2026-09-07T14:45:43.995Z\",\"publisher\":{\"@id\":\"https://docs.talkpilot.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.talkpilot.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TalkPilot\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TalkPilot","nav":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api/agents"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Resources","pages":[{"title":"Agents","href":"/api/agents"},{"title":"Workflow","href":"/api/workflow"},{"title":"Tools","href":"/api/tools"},{"title":"Employees","href":"/api/employees"},{"title":"Contacts","href":"/api/contacts"},{"title":"Forwarding Slots","href":"/api/forwarding-slots"},{"title":"Knowledge Base","href":"/api/knowledge-base"},{"title":"Calls","href":"/api/calls"},{"title":"Performance","href":"/api/performance"},{"title":"Organizations","href":"/api/organization"},{"title":"API Keys","href":"/api/api-keys"}]},{"group":"Endpoint Reference","pages":[{"group":"Health","pages":[{"openapi":"get /v1/health","title":"Health check","href":"/api-reference/health/health-check"}]},{"group":"Agents","pages":[{"openapi":"get /v1/agents","title":"List agents","href":"/api-reference/agents/list-agents"},{"openapi":"post /v1/agents","title":"Create an agent","description":"Creates a new agent in one of your organizations. The agent starts\n**without a phone number** and is therefore not reachable until a number\n(or a WhatsApp binding) is assigned.\n\n**Dashboard login only:** requires a JWT of a `super_admin` or `dev_admin`.\nAPI keys are rejected with `403 FORBIDDEN`, even with `agents:write`.\n\n`organization_id` and `name` are required; every other field is optional\nand accepts the same values as `PATCH /v1/agents/{agentId}`. Omitted fields\nget the same defaults as in the dashboard: empty prompt, `language: de`,\n`speaking_rate: 1.0`, `is_active: true`, `llm_provider: azure`,\n`llm_model: gpt-4.1`, and a voice matching the LLM provider (Cartesia\n\"Alina\" (German) with Soniox STT by default; `Puck` for `gemini_live`, `marin` for\n`openai_realtime`).\n\n`phone_number`, `created_by`, `id` and unknown fields are rejected with\n`400 VALIDATION_ERROR`. An `organization_id` you are not a member of\nreturns `404 NOT_FOUND`.\n","href":"/api-reference/agents/create-an-agent"},{"openapi":"get /v1/agents/{agentId}","title":"Get agent details","href":"/api-reference/agents/get-agent-details"},{"openapi":"patch /v1/agents/{agentId}","title":"Update agent settings","description":"Partially update an agent's configuration. Only include the fields\nyou want to change. Omitted fields remain unchanged.\n\n**Note:** `phone_number`, `organization_id`, `metadata` and `retention_days`\nare read-only via the API; `workflow` has its own endpoint.\n\n**This endpoint is strict:** any field that is not updatable (unknown or\nread-only) is rejected with `400 VALIDATION_ERROR`, one `details` entry per\nfield. The other `PATCH` endpoints ignore unknown fields.\n","href":"/api-reference/agents/update-agent-settings"},{"openapi":"get /v1/agents/{agentId}/status","title":"Get agent status","href":"/api-reference/agents/get-agent-status"},{"openapi":"post /v1/agents/{agentId}/phone-number","title":"Assign a phone number","href":"/api-reference/agents/assign-a-phone-number"},{"openapi":"delete /v1/agents/{agentId}/phone-number","title":"Release a phone number","href":"/api-reference/agents/release-a-phone-number"}]},{"group":"Workflow","pages":[{"openapi":"get /v1/agents/{agentId}/workflow","title":"Get workflow","href":"/api-reference/workflow/get-workflow"},{"openapi":"put /v1/agents/{agentId}/workflow","title":"Replace workflow","href":"/api-reference/workflow/replace-workflow"}]},{"group":"Tools","pages":[{"openapi":"get /v1/agents/{agentId}/tools","title":"List agent tools","href":"/api-reference/tools/list-agent-tools"},{"openapi":"post /v1/agents/{agentId}/tools","title":"Create a tool","href":"/api-reference/tools/create-a-tool"},{"openapi":"get /v1/agents/{agentId}/tools/{toolId}","title":"Get a tool","href":"/api-reference/tools/get-a-tool"},{"openapi":"patch /v1/agents/{agentId}/tools/{toolId}","title":"Update a tool","href":"/api-reference/tools/update-a-tool"},{"openapi":"delete /v1/agents/{agentId}/tools/{toolId}","title":"Delete a tool","href":"/api-reference/tools/delete-a-tool"}]},{"group":"Employees","pages":[{"openapi":"get /v1/agents/{agentId}/employees","title":"List employees","href":"/api-reference/employees/list-employees"},{"openapi":"post /v1/agents/{agentId}/employees","title":"Create an employee","href":"/api-reference/employees/create-an-employee"},{"openapi":"get /v1/agents/{agentId}/employees/{employeeId}","title":"Get an employee","href":"/api-reference/employees/get-an-employee"},{"openapi":"patch /v1/agents/{agentId}/employees/{employeeId}","title":"Update an employee","href":"/api-reference/employees/update-an-employee"},{"openapi":"delete /v1/agents/{agentId}/employees/{employeeId}","title":"Delete an employee","href":"/api-reference/employees/delete-an-employee"}]},{"group":"Contacts","pages":[{"openapi":"get /v1/agents/{agentId}/contacts","title":"List contacts","href":"/api-reference/contacts/list-contacts"},{"openapi":"post /v1/agents/{agentId}/contacts","title":"Create a contact","href":"/api-reference/contacts/create-a-contact"},{"openapi":"get /v1/agents/{agentId}/contacts/{contactId}","title":"Get a contact","href":"/api-reference/contacts/get-a-contact"},{"openapi":"patch /v1/agents/{agentId}/contacts/{contactId}","title":"Update a contact","href":"/api-reference/contacts/update-a-contact"},{"openapi":"delete /v1/agents/{agentId}/contacts/{contactId}","title":"Delete a contact","href":"/api-reference/contacts/delete-a-contact"}]},{"group":"Forwarding Slots","pages":[{"openapi":"get /v1/agents/{agentId}/forwarding-slots","title":"List forwarding slots","href":"/api-reference/forwarding-slots/list-forwarding-slots"},{"openapi":"post /v1/agents/{agentId}/forwarding-slots","title":"Create a forwarding slot","href":"/api-reference/forwarding-slots/create-a-forwarding-slot"},{"openapi":"put /v1/agents/{agentId}/forwarding-slots","title":"Replace all forwarding slots","href":"/api-reference/forwarding-slots/replace-all-forwarding-slots"},{"openapi":"patch /v1/agents/{agentId}/forwarding-slots/{slotId}","title":"Update a forwarding slot","href":"/api-reference/forwarding-slots/update-a-forwarding-slot"},{"openapi":"delete /v1/agents/{agentId}/forwarding-slots/{slotId}","title":"Delete a forwarding slot","href":"/api-reference/forwarding-slots/delete-a-forwarding-slot"}]},{"group":"Knowledge Base","pages":[{"openapi":"get /v1/agents/{agentId}/knowledge-base","title":"List knowledge base documents","href":"/api-reference/knowledge-base/list-knowledge-base-documents"},{"openapi":"post /v1/agents/{agentId}/knowledge-base","title":"Create a knowledge base document","href":"/api-reference/knowledge-base/create-a-knowledge-base-document"},{"openapi":"get /v1/agents/{agentId}/knowledge-base/{documentId}","title":"Get a knowledge base document","href":"/api-reference/knowledge-base/get-a-knowledge-base-document"},{"openapi":"patch /v1/agents/{agentId}/knowledge-base/{documentId}","title":"Update a knowledge base document","href":"/api-reference/knowledge-base/update-a-knowledge-base-document"},{"openapi":"delete /v1/agents/{agentId}/knowledge-base/{documentId}","title":"Delete a knowledge base document","href":"/api-reference/knowledge-base/delete-a-knowledge-base-document"},{"openapi":"get /v1/agents/{agentId}/knowledge-base/{documentId}/chunks","title":"List chunks for a document","href":"/api-reference/knowledge-base/list-chunks-for-a-document"},{"openapi":"post /v1/agents/{agentId}/knowledge-base/{documentId}/chunks","title":"Create chunks (batch)","href":"/api-reference/knowledge-base/create-chunks-batch"},{"openapi":"delete /v1/agents/{agentId}/knowledge-base/{documentId}/chunks","title":"Delete all chunks for a document","href":"/api-reference/knowledge-base/delete-all-chunks-for-a-document"}]},{"group":"Calls","pages":[{"openapi":"get /v1/agents/{agentId}/calls","title":"List calls","href":"/api-reference/calls/list-calls"},{"openapi":"get /v1/agents/{agentId}/calls/{callId}","title":"Get call details","href":"/api-reference/calls/get-call-details"}]},{"group":"Performance","pages":[{"openapi":"get /v1/agents/{agentId}/performance","title":"List performance records","href":"/api-reference/performance/list-performance-records"},{"openapi":"get /v1/agents/{agentId}/performance/{statisticId}","title":"Get performance record details","href":"/api-reference/performance/get-performance-record-details"}]},{"group":"Organization","pages":[{"openapi":"get /v1/organization","title":"List organizations","href":"/api-reference/organization/list-organizations"},{"openapi":"patch /v1/organization/{orgId}","title":"Update organization settings","href":"/api-reference/organization/update-organization-settings"}]},{"group":"API Keys","pages":[{"openapi":"get /v1/api-keys","title":"List API keys","href":"/api-reference/api-keys/list-api-keys"},{"openapi":"post /v1/api-keys","title":"Create an API key","href":"/api-reference/api-keys/create-an-api-key"},{"openapi":"patch /v1/api-keys/{keyId}","title":"Update an API key","href":"/api-reference/api-keys/update-an-api-key"},{"openapi":"delete /v1/api-keys/{keyId}","title":"Revoke an API key","href":"/api-reference/api-keys/revoke-an-api-key"}]}]},{"group":"Guides","pages":[{"title":"Pagination","href":"/guides/pagination"},{"title":"Error Handling","href":"/guides/error-handling"},{"title":"Rate Limiting","href":"/guides/rate-limiting"},{"title":"Webhooks","href":"/guides/webhooks"}]},{"group":"Code Examples","pages":[{"title":"cURL Examples","href":"/examples/curl"},{"title":"JavaScript / TypeScript Examples","href":"/examples/javascript"},{"title":"Python Examples","href":"/examples/python"}]}]}]},"basePath":"","title":"Get agent details - TalkPilot","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}