Secret API key (omic_...) obtained from the OpenMic dashboard. The public key (omic_pub_...) is only accepted by /whoami, /create-web-call, and the agent test-call endpoints; every other endpoint rejects it with 403 This endpoint requires a private API key.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenMic","colors":{"primary":"#7C3AED","light":"#A78BFA","dark":"#5B21B6"},"logo":{"light":"https://mintcdn.com/openmic-ea75a20d/zvTwGm0WP3eu7xLT/images/openmic-light-logo.svg?fit=max\u0026auto=format\u0026n=zvTwGm0WP3eu7xLT\u0026q=85\u0026s=4b1800ec8b4fa160ce7a3123c9b87e75","dark":"https://mintcdn.com/openmic-ea75a20d/zvTwGm0WP3eu7xLT/images/openmic-dark-logo.svg?fit=max\u0026auto=format\u0026n=zvTwGm0WP3eu7xLT\u0026q=85\u0026s=eb1da284be4c46e91af84f33b8628630"},"favicon":"https://mintcdn.com/openmic-ea75a20d/zvTwGm0WP3eu7xLT/favicon.svg?fit=max\u0026auto=format\u0026n=zvTwGm0WP3eu7xLT\u0026q=85\u0026s=1b4d9f2fc7c53b05fc9f68b30aecbccd","navbar":{"links":[{"href":"mailto:founders@openmic.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://chat.openmic.ai/login"}},"footer":{"socials":{"x":"https://twitter.com/openmic","github":"https://github.com/OpenMic","linkedin":"https://www.linkedin.com/showcase/openmicai"}},"integrations":{"mixpanel":{"projectToken":"6ccb514cfdb55d58633aa1ced0b19bcf"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.openmic.ai"},{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/openmicai/shared_invite/zt-2ha8kt9pt-jaElinNxF4VgN5gyCC6spg"},{"anchor":"Blog","icon":"newspaper","href":"https://openmic.ai/blog"},{"anchor":"Pricing","icon":"dollar-sign","href":"https://www.openmic.ai/pricing"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"openmic-ea75a20d","hasAudioNarration":false,"actualSubdomain":"openmic-ea75a20d","customDomains":["docs.openmic.ai"],"gitSource":{"type":"github","owner":"openmicai","repo":"openmic-platform","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac4b9219407f888ae78170f","collectionId":"58c540d4-9d2e-4833-bf14-5efba1b1455e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac4b9219407f888ae78170f"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae0a9fccdcf99f97c316aad","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":75},{"language":"default","tag":"V2","count":41},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Legacy","count":34},{"language":"default","tag":"Integrations","count":16},{"language":"default","tag":"Contact Lists","count":15},{"language":"default","tag":"Agents","count":14},{"language":"default","tag":"Tools","count":12},{"language":"default","tag":"Campaigns","count":10},{"language":"default","tag":"Phone Numbers","count":8}]},"assistantConfig":{},"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference-v2/agents/create-agent","slug":"/api-reference-v2/agents/create-agent","pageMetadata":{"openapi":"post /v2/agents","title":"Create an agent","description":"Creates a new voice AI agent.\n\n> **Note:** `first_message` and `auto_first_message` are mutually exclusive. Providing both returns a `400` error.","href":"/api-reference-v2/agents/create-agent"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n blockquote: \"blockquote\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a new voice AI agent.\"\n }), \"\\n\", _jsxs(_components.blockquote, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Note:\"\n }), \" \", _jsx(_components.code, {\n children: \"first_message\"\n }), \" and \", _jsx(_components.code, {\n children: \"auto_first_message\"\n }), \" are mutually exclusive. Providing both returns a \", _jsx(_components.code, {\n children: \"400\"\n }), \" error.\"]\n }), \"\\n\"]\n })]\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":"post /v2/agents","title":"Create an agent","description":"Creates a new voice AI agent.\n\n> **Note:** `first_message` and `auto_first_message` are mutually exclusive. Providing both returns a `400` error.","href":"/api-reference-v2/agents/create-agent"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createAgent","summary":"Create an agent","description":"Creates a new voice AI agent.\n\n> **Note:** `first_message` and `auto_first_message` are mutually exclusive. Providing both returns a `400` error.","tags":["Agents"],"requestBody":"6a2a3df8-1d10-4a86-91d6-02ad61f5dbad","responses":{"201":"6936789b-684c-4be8-9f38-c456bb153a06","400":"98c3557e-e715-4a5e-a462-7f7d183447d6","401":"4a50985b-fe64-4b07-87fa-1d4b777bb524","404":"1a661e81-28b8-4107-bbc2-b1abf8ea43e9","429":"44c45922-81f2-434c-b581-2ac9f83359ba","500":"5f7a44ca-90d3-4366-b54a-0cfb967af159"},"method":"post","type":"path","servers":["dce0ee74-2d34-4c29-9a4d-b90d20eea75a"],"security":["faa7350a-718e-4f55-b6f1-ba7f462e0b84"],"path":"/v2/agents","baseUrlOptions":["https://api.openmic.ai"],"title":"Create an agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","prompt"],"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"prompt":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"prompt","typeLabel":"string"},"first_message":{"type":"string","description":"Cannot be combined with `auto_first_message: true`.","uniqueKey":"first_message","typeLabel":"string"},"auto_first_message":{"type":"boolean","description":"Cannot be combined with `first_message`.","uniqueKey":"auto_first_message","typeLabel":"boolean"},"knowledge_base_id":{"type":"integer","uniqueKey":"knowledge_base_id","typeLabel":"integer"},"voice_provider":{"type":"string","enum":["OpenAI","ElevenLabs","Deepgram","Cartesia"],"uniqueKey":"voice_provider","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","uniqueKey":"voice","typeLabel":"string"},"voice_model":{"type":"string","uniqueKey":"voice_model","typeLabel":"string"},"voice_speed":{"type":"number","uniqueKey":"voice_speed","typeLabel":"number"},"llm_model_name":{"type":"string","uniqueKey":"llm_model_name","typeLabel":"string"},"llm_model_temperature":{"type":"number","minimum":0,"maximum":2,"uniqueKey":"llm_model_temperature","typeLabel":"number"},"llm_max_tokens":{"type":"integer","uniqueKey":"llm_max_tokens","typeLabel":"integer"},"stt_provider":{"type":"string","enum":["Deepgram"],"uniqueKey":"stt_provider","typeLabel":"enum\u003cstring>"},"stt_model":{"type":"string","uniqueKey":"stt_model","typeLabel":"string"},"auto_end_call":{"type":"boolean","uniqueKey":"auto_end_call","typeLabel":"boolean"},"call_settings":{"type":"object","properties":{"max_call_duration":{"type":"integer","minimum":2,"maximum":30,"description":"Maximum call duration in minutes.","uniqueKey":"call_settings.max_call_duration","typeLabel":"integer"},"silence_timeout":{"type":"integer","minimum":5,"maximum":45,"description":"Seconds of silence before timing out.","uniqueKey":"call_settings.silence_timeout","typeLabel":"integer"},"silence_timeout_max_retries":{"type":"integer","minimum":1,"maximum":5,"uniqueKey":"call_settings.silence_timeout_max_retries","typeLabel":"integer"},"silence_timeout_message":{"type":"string","uniqueKey":"call_settings.silence_timeout_message","typeLabel":"string"},"call_recording_enabled":{"type":"boolean","uniqueKey":"call_settings.call_recording_enabled","typeLabel":"boolean"},"voicemail_detection_enabled":{"type":"boolean","uniqueKey":"call_settings.voicemail_detection_enabled","typeLabel":"boolean"},"voicemail_action":{"type":"string","enum":["hangup","leave_message"],"uniqueKey":"call_settings.voicemail_action","typeLabel":"enum\u003cstring>"},"voicemail_message_type":{"type":"string","enum":["prompt","static"],"uniqueKey":"call_settings.voicemail_message_type","typeLabel":"enum\u003cstring>"},"voicemail_message":{"type":"string","uniqueKey":"call_settings.voicemail_message","typeLabel":"string"},"voicemail_post_detection_delay":{"type":"integer","minimum":0,"maximum":30,"uniqueKey":"call_settings.voicemail_post_detection_delay","typeLabel":"integer"},"hipaa_compliance_enabled":{"type":"boolean","uniqueKey":"call_settings.hipaa_compliance_enabled","typeLabel":"boolean"},"pci_compliance_enabled":{"type":"boolean","uniqueKey":"call_settings.pci_compliance_enabled","typeLabel":"boolean"}},"uniqueKey":"call_settings","typeLabel":"object"},"advanced_settings":{"type":"object","properties":{"agent_personality":{"type":"string","enum":["casual","humorous","direct","formal","persuasive","friendly"],"uniqueKey":"advanced_settings.agent_personality","typeLabel":"enum\u003cstring>"},"humanize_conversation":{"type":"boolean","uniqueKey":"advanced_settings.humanize_conversation","typeLabel":"boolean"},"background_noise_reduction":{"type":"boolean","uniqueKey":"advanced_settings.background_noise_reduction","typeLabel":"boolean"},"allow_interruptions":{"type":"boolean","uniqueKey":"advanced_settings.allow_interruptions","typeLabel":"boolean"},"min_interruption_duration":{"type":"number","minimum":0.2,"maximum":5,"uniqueKey":"advanced_settings.min_interruption_duration","typeLabel":"number"},"background_sound":{"type":"string","uniqueKey":"advanced_settings.background_sound","typeLabel":"string"},"agent_response_length":{"type":"string","enum":["normal","short","concise","long"],"uniqueKey":"advanced_settings.agent_response_length","typeLabel":"enum\u003cstring>"},"short_pause":{"type":"number","minimum":0.2,"maximum":2,"uniqueKey":"advanced_settings.short_pause","typeLabel":"number"},"long_pause":{"type":"number","minimum":0.5,"maximum":6,"uniqueKey":"advanced_settings.long_pause","typeLabel":"number"},"filter_phrases":{"type":"string","uniqueKey":"advanced_settings.filter_phrases","typeLabel":"string"}},"uniqueKey":"advanced_settings","typeLabel":"object"},"boosted_keywords":{"type":"array","items":{"type":"string","uniqueKey":"boosted_keywords.items.[INDEX]","typeLabel":"string"},"maxItems":30,"uniqueKey":"boosted_keywords","typeLabel":"string[]"},"selected_jargons":{"type":"array","items":{"type":"string","uniqueKey":"selected_jargons.items.[INDEX]","typeLabel":"string"},"uniqueKey":"selected_jargons","typeLabel":"string[]"},"post_call_settings":{"type":"object","properties":{"summary_prompt":{"type":"string","uniqueKey":"post_call_settings.summary_prompt","typeLabel":"string"},"success_evaluation_prompt":{"type":"string","uniqueKey":"post_call_settings.success_evaluation_prompt","typeLabel":"string"},"success_evaluation_rubric_type":{"type":"string","enum":["NUMERIC_SCALE","DESCRIPTIVE_SCALE","PERCENTAGE_SCALE","LIKERT_SCALE","PASS_FAIL","SENTIMENT"],"uniqueKey":"post_call_settings.success_evaluation_rubric_type","typeLabel":"enum\u003cstring>"},"structured_extraction_prompt":{"type":"string","uniqueKey":"post_call_settings.structured_extraction_prompt","typeLabel":"string"},"structured_extraction_json_schema":{"type":"object","description":"A valid JSON Schema object describing the fields to extract.","uniqueKey":"post_call_settings.structured_extraction_json_schema","typeLabel":"object"}},"uniqueKey":"post_call_settings","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"Support Agent","prompt":"You are a friendly customer support agent for Acme Corp.","first_message":"Hello! How can I help you today?","voice_provider":"ElevenLabs","voice":"rachel","llm_model_name":"gpt-4o","call_settings":{"max_call_duration":10,"call_recording_enabled":true},"advanced_settings":{"agent_personality":"friendly","allow_interruptions":true}},"examples":{"Example":{"title":"Example","value":{"name":"Support Agent","prompt":"You are a friendly customer support agent for Acme Corp.","first_message":"Hello! How can I help you today?","voice_provider":"ElevenLabs","voice":"rachel","llm_model_name":"gpt-4o","call_settings":{"max_call_duration":10,"call_recording_enabled":true},"advanced_settings":{"agent_personality":"friendly","allow_interruptions":true}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"6936789b-684c-4be8-9f38-c456bb153a06":{"description":"Agent created.","content":{"application/json":{"schema":{"type":"object","required":["uid","name","prompt","created_at","updated_at"],"properties":{"uid":{"type":"string","description":"Unique agent identifier (slug/UUID).","isRequired":true,"uniqueKey":"uid","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"prompt":{"type":"string","isRequired":true,"uniqueKey":"prompt","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"first_message":{"type":"string","uniqueKey":"first_message","typeLabel":"string"},"auto_first_message":{"type":"boolean","uniqueKey":"auto_first_message","typeLabel":"boolean"},"knowledge_base_id":{"type":"integer","uniqueKey":"knowledge_base_id","typeLabel":"integer"},"voice_provider":{"type":"string","enum":["OpenAI","ElevenLabs","Deepgram","Cartesia"],"uniqueKey":"voice_provider","typeLabel":"enum\u003cstring>"},"voice":{"type":"string","uniqueKey":"voice","typeLabel":"string"},"voice_model":{"type":"string","uniqueKey":"voice_model","typeLabel":"string"},"voice_speed":{"type":"number","uniqueKey":"voice_speed","typeLabel":"number"},"llm_model_name":{"type":"string","uniqueKey":"llm_model_name","typeLabel":"string"},"llm_model_temperature":{"type":"number","minimum":0,"maximum":2,"uniqueKey":"llm_model_temperature","typeLabel":"number"},"llm_max_tokens":{"type":"integer","uniqueKey":"llm_max_tokens","typeLabel":"integer"},"stt_provider":{"type":"string","enum":["Deepgram"],"uniqueKey":"stt_provider","typeLabel":"enum\u003cstring>"},"stt_model":{"type":"string","uniqueKey":"stt_model","typeLabel":"string"},"auto_end_call":{"type":"boolean","uniqueKey":"auto_end_call","typeLabel":"boolean"},"call_settings":{"type":"object","properties":{"max_call_duration":{"type":"integer","minimum":2,"maximum":30,"description":"Maximum call duration in minutes.","uniqueKey":"call_settings.max_call_duration","typeLabel":"integer"},"silence_timeout":{"type":"integer","minimum":5,"maximum":45,"description":"Seconds of silence before timing out.","uniqueKey":"call_settings.silence_timeout","typeLabel":"integer"},"silence_timeout_max_retries":{"type":"integer","minimum":1,"maximum":5,"uniqueKey":"call_settings.silence_timeout_max_retries","typeLabel":"integer"},"silence_timeout_message":{"type":"string","uniqueKey":"call_settings.silence_timeout_message","typeLabel":"string"},"call_recording_enabled":{"type":"boolean","uniqueKey":"call_settings.call_recording_enabled","typeLabel":"boolean"},"voicemail_detection_enabled":{"type":"boolean","uniqueKey":"call_settings.voicemail_detection_enabled","typeLabel":"boolean"},"voicemail_action":{"type":"string","enum":["hangup","leave_message"],"uniqueKey":"call_settings.voicemail_action","typeLabel":"enum\u003cstring>"},"voicemail_message_type":{"type":"string","enum":["prompt","static"],"uniqueKey":"call_settings.voicemail_message_type","typeLabel":"enum\u003cstring>"},"voicemail_message":{"type":"string","uniqueKey":"call_settings.voicemail_message","typeLabel":"string"},"voicemail_post_detection_delay":{"type":"integer","minimum":0,"maximum":30,"uniqueKey":"call_settings.voicemail_post_detection_delay","typeLabel":"integer"},"hipaa_compliance_enabled":{"type":"boolean","uniqueKey":"call_settings.hipaa_compliance_enabled","typeLabel":"boolean"},"pci_compliance_enabled":{"type":"boolean","uniqueKey":"call_settings.pci_compliance_enabled","typeLabel":"boolean"}},"uniqueKey":"call_settings","typeLabel":"object"},"advanced_settings":{"type":"object","properties":{"agent_personality":{"type":"string","enum":["casual","humorous","direct","formal","persuasive","friendly"],"uniqueKey":"advanced_settings.agent_personality","typeLabel":"enum\u003cstring>"},"humanize_conversation":{"type":"boolean","uniqueKey":"advanced_settings.humanize_conversation","typeLabel":"boolean"},"background_noise_reduction":{"type":"boolean","uniqueKey":"advanced_settings.background_noise_reduction","typeLabel":"boolean"},"allow_interruptions":{"type":"boolean","uniqueKey":"advanced_settings.allow_interruptions","typeLabel":"boolean"},"min_interruption_duration":{"type":"number","minimum":0.2,"maximum":5,"uniqueKey":"advanced_settings.min_interruption_duration","typeLabel":"number"},"background_sound":{"type":"string","uniqueKey":"advanced_settings.background_sound","typeLabel":"string"},"agent_response_length":{"type":"string","enum":["normal","short","concise","long"],"uniqueKey":"advanced_settings.agent_response_length","typeLabel":"enum\u003cstring>"},"short_pause":{"type":"number","minimum":0.2,"maximum":2,"uniqueKey":"advanced_settings.short_pause","typeLabel":"number"},"long_pause":{"type":"number","minimum":0.5,"maximum":6,"uniqueKey":"advanced_settings.long_pause","typeLabel":"number"},"filter_phrases":{"type":"string","uniqueKey":"advanced_settings.filter_phrases","typeLabel":"string"}},"uniqueKey":"advanced_settings","typeLabel":"object"},"boosted_keywords":{"type":"array","items":{"type":"string","uniqueKey":"boosted_keywords.items.[INDEX]","typeLabel":"string"},"maxItems":30,"uniqueKey":"boosted_keywords","typeLabel":"string[]"},"selected_jargons":{"type":"array","items":{"type":"string","uniqueKey":"selected_jargons.items.[INDEX]","typeLabel":"string"},"uniqueKey":"selected_jargons","typeLabel":"string[]"},"post_call_settings":{"type":"object","properties":{"summary_prompt":{"type":"string","uniqueKey":"post_call_settings.summary_prompt","typeLabel":"string"},"success_evaluation_prompt":{"type":"string","uniqueKey":"post_call_settings.success_evaluation_prompt","typeLabel":"string"},"success_evaluation_rubric_type":{"type":"string","enum":["NUMERIC_SCALE","DESCRIPTIVE_SCALE","PERCENTAGE_SCALE","LIKERT_SCALE","PASS_FAIL","SENTIMENT"],"uniqueKey":"post_call_settings.success_evaluation_rubric_type","typeLabel":"enum\u003cstring>"},"structured_extraction_prompt":{"type":"string","uniqueKey":"post_call_settings.structured_extraction_prompt","typeLabel":"string"},"structured_extraction_json_schema":{"type":"object","description":"A valid JSON Schema object describing the fields to extract.","uniqueKey":"post_call_settings.structured_extraction_json_schema","typeLabel":"object"}},"uniqueKey":"post_call_settings","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"uid":"\u003cstring>","name":"\u003cstring>","prompt":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","first_message":"\u003cstring>","auto_first_message":true,"knowledge_base_id":123,"voice_provider":"OpenAI","voice":"\u003cstring>","voice_model":"\u003cstring>","voice_speed":123,"llm_model_name":"\u003cstring>","llm_model_temperature":1,"llm_max_tokens":123,"stt_provider":"Deepgram","stt_model":"\u003cstring>","auto_end_call":true,"call_settings":{"max_call_duration":16,"silence_timeout":25,"silence_timeout_max_retries":3,"silence_timeout_message":"\u003cstring>","call_recording_enabled":true,"voicemail_detection_enabled":true,"voicemail_action":"hangup","voicemail_message_type":"prompt","voicemail_message":"\u003cstring>","voicemail_post_detection_delay":15,"hipaa_compliance_enabled":true,"pci_compliance_enabled":true},"advanced_settings":{"agent_personality":"casual","humanize_conversation":true,"background_noise_reduction":true,"allow_interruptions":true,"min_interruption_duration":2.6,"background_sound":"\u003cstring>","agent_response_length":"normal","short_pause":1.1,"long_pause":3.25,"filter_phrases":"\u003cstring>"},"boosted_keywords":["\u003cstring>"],"selected_jargons":["\u003cstring>"],"post_call_settings":{"summary_prompt":"\u003cstring>","success_evaluation_prompt":"\u003cstring>","success_evaluation_rubric_type":"NUMERIC_SCALE","structured_extraction_prompt":"\u003cstring>","structured_extraction_json_schema":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"98c3557e-e715-4a5e-a462-7f7d183447d6":{"description":"Validation error or invalid request body.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4a50985b-fe64-4b07-87fa-1d4b777bb524":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1a661e81-28b8-4107-bbc2-b1abf8ea43e9":{"description":"The requested resource does not exist.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"44c45922-81f2-434c-b581-2ac9f83359ba":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"retryAfter":{"type":"integer","uniqueKey":"retryAfter","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","error":"\u003cstring>","retryAfter":123}}},"exampleType":"generated"}},"exampleType":"generated"},"5f7a44ca-90d3-4366-b54a-0cfb967af159":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"faa7350a-718e-4f55-b6f1-ba7f462e0b84":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Secret API key (`omic_...`) obtained from the OpenMic dashboard. The public key (`omic_pub_...`) is only accepted by `/whoami`, `/create-web-call`, and the agent test-call endpoints; every other endpoint rejects it with `403 This endpoint requires a private API key`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"dce0ee74-2d34-4c29-9a4d-b90d20eea75a":{"url":"https://api.openmic.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Secret API key (`omic_...`) obtained from the OpenMic dashboard. The public key (`omic_pub_...`) is only accepted by `/whoami`, `/create-web-call`, and the agent test-call endpoints; every other endpoint rejects it with `403 This endpoint requires a private API key`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Secret API key (`omic_...`) obtained from the OpenMic dashboard. The public key (`omic_pub_...`) is only accepted by `/whoami`, `/create-web-call`, and the agent test-call endpoints; every other endpoint rejects it with `403 This endpoint requires a private API key`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"OpenMic-v2.json"},"subdomain":"openmic-ea75a20d","siteName":"OpenMic","title":"Create an agent - OpenMic","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-28T19:55:39.219Z","originalFileLocation":"api-reference-v2/agents/create-agent.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=\"Creates a new voice AI agent. \u0026gt; Note: first_message and auto_first_message are mutually exclusive. Providing both returns a 400 error.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpenMic\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an agent - OpenMic\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new voice AI agent. \u0026gt; Note: first_message and auto_first_message are mutually exclusive. Providing both returns a 400 error.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenMic\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openmic.ai/api-reference-v2/agents/create-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://openmic-ea75a20d.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Create+an+agent\u0026amp;description=Creates+a+new+voice+AI+agent.%0A%0A%3E+**Note%3A**+%60first_message%60+and+%60auto_first_message%60+are+mutually+exclusive.+Providing+both+returns+a+%60400%60+error.\u0026amp;theme=2fda07862c213e343a9d1cc3\u0026amp;signature=7f8d0444339457163d2ee5a59d2adc14776a1db36dea46d18d2f49513e1892d6\">\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=\"Create an agent - OpenMic\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new voice AI agent. \u0026gt; Note: first_message and auto_first_message are mutually exclusive. Providing both returns a 400 error.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://openmic-ea75a20d.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Create+an+agent\u0026amp;description=Creates+a+new+voice+AI+agent.%0A%0A%3E+**Note%3A**+%60first_message%60+and+%60auto_first_message%60+are+mutually+exclusive.+Providing+both+returns+a+%60400%60+error.\u0026amp;theme=2fda07862c213e343a9d1cc3\u0026amp;signature=7f8d0444339457163d2ee5a59d2adc14776a1db36dea46d18d2f49513e1892d6\">\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/openmic-ea75a20d/cAbsg8MHY5kcb3Mz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenMic\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C3AED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openmic.ai/api-reference-v2/agents/create-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference-v2/agents/create-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openmic.ai/#organization\",\"name\":\"OpenMic\",\"url\":\"https://docs.openmic.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/openmic-ea75a20d/zvTwGm0WP3eu7xLT/images/openmic-light-logo.svg?fit=max\u0026auto=format\u0026n=zvTwGm0WP3eu7xLT\u0026q=85\u0026s=4b1800ec8b4fa160ce7a3123c9b87e75\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openmic.ai#website\",\"name\":\"OpenMic\",\"url\":\"https://docs.openmic.ai\",\"publisher\":{\"@id\":\"https://docs.openmic.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent#webpage\",\"url\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent\",\"name\":\"Create an agent\",\"description\":\"Creates a new voice AI agent. > Note: first_message and auto_first_message are mutually exclusive. Providing both returns a 400 error.\",\"dateModified\":\"2026-04-28T19:55:39.219Z\",\"isPartOf\":{\"@id\":\"https://docs.openmic.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"V2\",\"item\":\"https://docs.openmic.ai/api-reference-v2/auth/whoami\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.openmic.ai/api-reference-v2/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create an agent\",\"item\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent#apireference\",\"headline\":\"Create an agent\",\"name\":\"Create an agent\",\"description\":\"Creates a new voice AI agent. > Note: first_message and auto_first_message are mutually exclusive. Providing both returns a 400 error.\",\"url\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openmic.ai/api-reference-v2/agents/create-agent#webpage\"},\"dateModified\":\"2026-04-28T19:55:39.219Z\",\"publisher\":{\"@id\":\"https://docs.openmic.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openmic.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenMic\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OpenMic","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.openmic.ai"},{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/openmicai/shared_invite/zt-2ha8kt9pt-jaElinNxF4VgN5gyCC6spg"},{"anchor":"Blog","icon":"newspaper","href":"https://openmic.ai/blog"},{"anchor":"Pricing","icon":"dollar-sign","href":"https://www.openmic.ai/pricing"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"V2","pages":[{"group":"Auth","pages":[{"openapi":"get /v2/whoami","title":"Get current user info","href":"/api-reference-v2/auth/whoami"}]},{"group":"Agents","pages":[{"openapi":"get /v2/agents","title":"List agents","description":"Returns a cursor-paginated list of agents belonging to your organization. Results are ordered newest-first.","href":"/api-reference-v2/agents/list-agents"},{"openapi":"post /v2/agents","title":"Create an agent","href":"/api-reference-v2/agents/create-agent"},{"openapi":"get /v2/agents/{uid}","title":"Get an agent","description":"Returns the full details of a single agent.","href":"/api-reference-v2/agents/get-agent"},{"openapi":"patch /v2/agents/{uid}","title":"Update an agent","href":"/api-reference-v2/agents/update-agent"},{"openapi":"delete /v2/agents/{uid}","title":"Delete an agent","href":"/api-reference-v2/agents/delete-agent"}]},{"group":"Calls","pages":[{"openapi":"post /v2/create-phone-call","title":"Create an outbound phone call","href":"/api-reference-v2/calls/create-call"},{"openapi":"get /v2/calls","title":"List calls","href":"/api-reference-v2/calls/list-calls"},{"openapi":"get /v2/call/{id}","title":"Get a call","href":"/api-reference-v2/calls/get-call"}]},{"group":"Phone Numbers","pages":[{"openapi":"get /v2/phone-numbers","title":"List phone numbers","href":"/api-reference-v2/phone-numbers/list-numbers"},{"openapi":"get /v2/phone-numbers/{phone_number_id}","title":"Get a phone number","href":"/api-reference-v2/phone-numbers/get-number"},{"openapi":"post /v2/phone-numbers/link-agent","title":"Link an agent to a phone number","href":"/api-reference-v2/phone-numbers/link-bot"},{"openapi":"post /v2/phone-numbers/unlink-agent","title":"Unlink an agent from a phone number","href":"/api-reference-v2/phone-numbers/unlink-bot"}]},{"group":"Tools","pages":[{"openapi":"get /v2/agents/{agent_uid}/tools","title":"List tools for an agent","href":"/api-reference-v2/tools/list-tools"},{"openapi":"post /v2/agents/{agent_uid}/tools","title":"Create a tool for an agent","href":"/api-reference-v2/tools/create-tool"},{"openapi":"get /v2/agents/{agent_uid}/tools/{tool_id}","title":"Get a tool","href":"/api-reference-v2/tools/get-tool"},{"openapi":"patch /v2/agents/{agent_uid}/tools/{tool_id}","title":"Update a tool","href":"/api-reference-v2/tools/update-tool"},{"openapi":"delete /v2/agents/{agent_uid}/tools/{tool_id}","title":"Delete a tool","href":"/api-reference-v2/tools/delete-tool"},{"title":"Send SMS Static Params","href":"/api-reference-v2/tools/send-sms-static-params"},{"title":"Transfer Call Static Params","href":"/api-reference-v2/tools/transfer-call-static-params"}]},{"group":"Contact Lists","pages":[{"openapi":"get /v2/contact-lists","title":"List contact lists","href":"/api-reference-v2/contact-lists/list-contact-lists"},{"openapi":"post /v2/contact-lists","title":"Create a contact list","href":"/api-reference-v2/contact-lists/create-contact-list"},{"openapi":"get /v2/contact-lists/{contact_list_id}","title":"Get a contact list","href":"/api-reference-v2/contact-lists/get-contact-list"},{"openapi":"patch /v2/contact-lists/{contact_list_id}","title":"Update a contact list","href":"/api-reference-v2/contact-lists/update-contact-list"},{"openapi":"delete /v2/contact-lists/{contact_list_id}","title":"Delete a contact list","href":"/api-reference-v2/contact-lists/delete-contact-list"},{"openapi":"get /v2/contact-lists/{contact_list_id}/contacts","title":"List contacts in a list","href":"/api-reference-v2/contacts/list-contacts"},{"openapi":"post /v2/contact-lists/{contact_list_id}/contacts","title":"Add a contact","href":"/api-reference-v2/contacts/create-contact"},{"openapi":"post /v2/contact-lists/{contact_list_id}/contacts/bulk","title":"Bulk add contacts","href":"/api-reference-v2/contacts/create-contacts-bulk"},{"openapi":"patch /v2/contact-lists/{contact_list_id}/contacts/{contact_id}","title":"Update a contact","href":"/api-reference-v2/contacts/update-contact"},{"openapi":"delete /v2/contact-lists/{contact_list_id}/contacts","title":"Delete contacts from a list","href":"/api-reference-v2/contacts/delete-contacts"}]},{"group":"Campaigns","pages":[{"openapi":"get /v2/campaigns","title":"List campaigns","href":"/api-reference-v2/campaigns/list-campaigns"},{"openapi":"post /v2/campaigns","title":"Create a campaign","href":"/api-reference-v2/campaigns/create-campaign"},{"openapi":"get /v2/campaigns/{campaign_id}","title":"Get a campaign","href":"/api-reference-v2/campaigns/get-campaign"},{"openapi":"patch /v2/campaigns/{campaign_id}","title":"Update a campaign","href":"/api-reference-v2/campaigns/update-campaign"},{"openapi":"delete /v2/campaigns/{campaign_id}","title":"Delete a campaign","href":"/api-reference-v2/campaigns/delete-campaign"}]},{"group":"SMS","pages":[{"openapi":"post /v2/send-sms","title":"Send SMS","href":"/api-reference-v2/sms/send-sms"},{"openapi":"get /v2/sms-logs","title":"List SMS logs","href":"/api-reference-v2/sms/list-sms-logs"},{"openapi":"get /v2/sms-logs/{sms_log_id}","title":"Get an SMS log","href":"/api-reference-v2/sms/get-sms-log"}]},{"group":"Usage","pages":[{"openapi":"get /v2/usage","title":"Get usage","href":"/api-reference-v2/usage/get-usage"}]},{"group":"Voices","pages":[{"openapi":"get /v2/voices","title":"List voices","href":"/api-reference-v2/voices/list-voices"},{"openapi":"get /v2/voices/{voice_id}","title":"Get a voice","href":"/api-reference-v2/voices/get-voice"}]}]},{"group":"Legacy","pages":[{"group":"Calls","pages":[{"openapi":"post /v1/create-phone-call","title":"Create Phone Call","href":"/api-reference/calls/create-call"},{"openapi":"get /v1/calls","title":"List Calls","href":"/api-reference/calls/list-calls"},{"openapi":"get /v1/call/{id}","title":"Get Call","href":"/api-reference/calls/get-call"}]},{"group":"Bots","pages":[{"openapi":"get /v1/bots","title":"List Bots","href":"/api-reference/bots/list-bots"},{"openapi":"post /v1/bots","title":"Create Bot","href":"/api-reference/bots/create-bot"},{"openapi":"get /v1/bots/{uid}","title":"Get Bot","href":"/api-reference/bots/get-bot"},{"openapi":"patch /v1/bots/{uid}","title":"Update Bot","href":"/api-reference/bots/update-bot"},{"openapi":"delete /v1/bots/{uid}","title":"Delete Bot","href":"/api-reference/bots/delete-bot"}]},{"group":"Tools","pages":[{"openapi":"get /v1/bots/{bot_uid}/tools","title":"List Tools","href":"/api-reference/tools/list-tools"},{"openapi":"post /v1/bots/{bot_uid}/tools","title":"Create Tool","href":"/api-reference/tools/create-tool"},{"openapi":"get /v1/bots/{bot_uid}/tools/{tool_id}","title":"Get Tool","href":"/api-reference/tools/get-tool"},{"openapi":"patch /v1/bots/{bot_uid}/tools/{tool_id}","title":"Update Tool","href":"/api-reference/tools/update-tool"},{"openapi":"delete /v1/bots/{bot_uid}/tools/{tool_id}","title":"Delete Tool","href":"/api-reference/tools/delete-tool"}]},{"group":"Phone Numbers","pages":[{"openapi":"get /v1/phone-numbers","title":"List Phone Numbers","href":"/api-reference/phone-numbers/list-numbers"},{"openapi":"get /v1/phone-numbers/{uid}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-number"},{"openapi":"post /v1/phone-numbers/link-agent","title":"Link Bot to Phone Number","href":"/api-reference/phone-numbers/link-bot"},{"openapi":"post /v1/phone-numbers/unlink-agent","title":"Unlink Bot from Phone Number","href":"/api-reference/phone-numbers/unlink-bot"}]},{"group":"Contact Lists","pages":[{"openapi":"get /v1/contact-lists","title":"List contact lists","href":"/api-reference/contact-lists/list-contact-lists"},{"openapi":"post /v1/contact-lists","title":"Create a contact list","href":"/api-reference/contact-lists/create-contact-list"},{"openapi":"get /v1/contact-lists/{contact_list_id}","title":"Get a contact list","href":"/api-reference/contact-lists/get-contact-list"},{"openapi":"patch /v1/contact-lists/{contact_list_id}","title":"Update a contact list","href":"/api-reference/contact-lists/update-contact-list"},{"openapi":"delete /v1/contact-lists/{contact_list_id}","title":"Delete a contact list","href":"/api-reference/contact-lists/delete-contact-list"}]},{"group":"Contacts","pages":[{"openapi":"get /v1/contact-lists/{contact_list_id}/contacts","title":"List contacts in a contact list","href":"/api-reference/contacts/list-contacts"},{"openapi":"post /v1/contact-lists/{contact_list_id}/contacts","title":"Add a single contact to a contact list","href":"/api-reference/contacts/create-contact"},{"openapi":"post /v1/contact-lists/{contact_list_id}/contacts/bulk","title":"Bulk add contacts to a contact list","href":"/api-reference/contacts/create-contacts-bulk"},{"openapi":"patch /v1/contact-lists/{contact_list_id}/contacts/{contact_id}","title":"Update a contact","href":"/api-reference/contacts/update-contact"},{"openapi":"delete /v1/contact-lists/{contact_list_id}/contacts","title":"Delete contacts from a contact list","href":"/api-reference/contacts/delete-contacts"}]},{"group":"Campaigns","pages":[{"openapi":"get /v1/campaigns","title":"List campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"post /v1/campaigns","title":"Create a campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"get /v1/campaigns/{campaign_id}","title":"Get a campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"patch /v1/campaigns/{campaign_id}","title":"Update a campaign","href":"/api-reference/campaigns/update-campaign"},{"openapi":"delete /v1/campaigns/{campaign_id}","title":"Delete a campaign","href":"/api-reference/campaigns/delete-campaign"}]},{"group":"Voices","pages":[{"openapi":"get /v1/voices","title":"List Voices","href":"/api-reference/voices/list-voices"},{"openapi":"get /v1/voices/{voice_id}","title":"Get Voice","href":"/api-reference/voices/get-voice"}]}]}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials/features/warm-call-transfer"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create an agent - OpenMic","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}