This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.
{
"success": true,
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "created",
"language": "<string>",
"timezone": "<string>",
"region_style": "<string>",
"coerced_fields": [
{
"key": "buyer_profile",
"requested_type": "select",
"saved_type": "text",
"reason": "no_options",
"hint": "This field was saved as text because it had no options. To make it a list, send it again with type select and a non-empty options array."
}
]
}
Idempotent. If an agent with the same name already exists on your account, this returns the existing one (status: "existed") instead of creating a duplicate — safe to retry.
Customer content limit
Each task has a maximum of 20,000 customer tokens, including its shared identity when it belongs to an agent. Nexor’s internal instructions do not use this allowance, but a task that takes calls also has a 28,000-token call limit that includes them. The limit covers the task configuration described in Your content limit.The API returns 422 CUSTOMER_PROMPT_TOO_LARGE when the resulting customer configuration exceeds this limit. If a call would exceed the call limit, it returns 503 VOICE_PROMPT_CAPACITY_EXCEEDED with capacity.tokens and capacity.limit. Shorten the prompt or instructions by at least capacity.tokens - capacity.limit tokens. Creation can involve several writes, so read the current task state before retrying a failed request.If the task’s call flow would exceed 390,000 bytes, the API returns 422 CONVERSATION_FLOW_TOO_LARGE with projected_bytes, limit, and the parts that drive its size. If the call flow cannot be built from the configuration, it returns 422 CONVERSATION_FLOW_CONFIGURATION_INVALID with a reason.
Non-empty array of funnel statuses (see below). If none is marked is_initial, the first one is used; if none is marked is_terminal, the last one is used
description
string
No
Agent description
global_prompt
string
No
Base prompt. You can also set this later via PATCH /workflows/:id/prompt
language
string
No
Default es
channels
array
No
Channels to enable, e.g. ["whatsapp", "email"]. Default ["whatsapp"]
fields
array
No
Custom lead fields to collect (see Update Structure for the shape). A select or multiselect field needs at least one option that is not blank in options; without one it is saved as text and listed in coerced_fields
Available goals
goal_type
Expected outcome
Notes
appointment
Book a meeting
Enables calendar capabilities.
payment_link
Send a payment link and complete payment
The integration that creates or supplies the link must be configured.
qualification
Qualify the lead from collected data
Pair it with fields and stages that express the criteria.
information
Answer questions
Usually depends on a knowledge base.
support
Resolve or escalate support requests
Define explicit escalation rules.
document_collection
Request and verify documents
The dashboard shows a Documents section for this goal.
quote
Generate a quote from a catalog
Requires an assigned catalog.
custom
Achieve an operator-written objective
Does not enable calendar tools.
sale
Complete a sale
API-compatible value; it is not a preset in the current dashboard picker.
Onboarding also offers Qualify, then book. That option is stored as appointment with a qualification pipeline and rules; do not send qualify_then_book to this public endpoint.
The custom goal
Use custom when the agent’s objective is not one of the preset goals — debt collection, client win-back, post-sale follow-up, or surveys. The agent pursues an objective written in the operator’s own words, configured in the Dashboard under Agent settings → Goal and stored as config.goal_statement. It accepts up to 600 characters and should describe the outcome, not the procedure. Two things to know:
A custom agent does not schedule meetings — the calendar tools are not available to it. If the goal ends in a booked meeting, use appointment.
You must send statuses as with every other goal. This endpoint does not infer the pipeline; a typical custom setup can use new → contacted → engaged → converted → lost with transition instructions adapted to the written outcome.
If a select or multiselect field in fields had no usable option, Nexor saves it as text and adds coerced_fields to the response. Each entry has the field’s key, requested_type, saved_type (text), reason (no_options), and a hint. To make the field a list, send it to Update Structure with type set to select or multiselect and a non-empty options array.
503 VOICE_PROMPT_BUDGET_UNAVAILABLE means Nexor could not complete the capacity check. Retry when validation is available.
Authorizations
X-API-Key
string
header
required
API key for authentication. Keys are prefixed with nxr_live_. To work inside a sub-account with a main account key, also send the optional X-Nexor-Sub-Account-Id header.
{
"success": true,
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"master_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "created",
"language": "<string>",
"timezone": "<string>",
"region_style": "<string>",
"coerced_fields": [
{
"key": "buyer_profile",
"requested_type": "select",
"saved_type": "text",
"reason": "no_options",
"hint": "This field was saved as text because it had no options. To make it a list, send it again with type select and a non-empty options array."
}
]
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Nexor","colors":{"primary":"#0A0A0A","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/nexor/f1Gy8zY6i2a68PTn/images/logo-black.svg?fit=max\u0026auto=format\u0026n=f1Gy8zY6i2a68PTn\u0026q=85\u0026s=2a5ea3c97db1c6499f5f24571b593e6f","dark":"https://mintcdn.com/nexor/f1Gy8zY6i2a68PTn/images/logo-white.svg?fit=max\u0026auto=format\u0026n=f1Gy8zY6i2a68PTn\u0026q=85\u0026s=65697db82c09cf7f5a5e76a512981d1e","href":"https://docs.getnexor.ai"},"favicon":{"light":"https://mintcdn.com/nexor/f1Gy8zY6i2a68PTn/images/icon.png?fit=max\u0026auto=format\u0026n=f1Gy8zY6i2a68PTn\u0026q=85\u0026s=321e364fa619df901dc06c5ef29d4125","dark":"https://mintcdn.com/nexor/f1Gy8zY6i2a68PTn/images/icon.png?fit=max\u0026auto=format\u0026n=f1Gy8zY6i2a68PTn\u0026q=85\u0026s=321e364fa619df901dc06c5ef29d4125"},"api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"prefill":true}},"navbar":{"links":[{"href":"https://app.getnexor.ai","label":"Ir a Nexor →"}]},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":["copy","assistant"],"display":"header"},"thumbnails":{"fonts":{"family":"Inter"}},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"schema":false},"navigation":{"languages":[{"language":"en","href":"docs/en/guides/getting-started"},{"language":"es","href":"docs/es/guides/getting-started"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nexor","hasAudioNarration":false,"actualSubdomain":"nexor","customDomains":["docs.getnexor.ai"],"gitSource":{"type":"github","owner":"getnexor-ai","repo":"nexor-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af7117677407407f8da0472","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"API reference","count":159},{"language":"es","tag":"Referencia API","count":159},{"language":"en","tag":"Leads","count":27},{"language":"es","tag":"Leads","count":27},{"language":"en","tag":"CRM Chat","count":25},{"language":"es","tag":"CRM por chat","count":25},{"language":"en","tag":"Agents","count":20},{"language":"es","tag":"Agentes","count":20},{"language":"en","tag":"Cloud Functions","count":19},{"language":"es","tag":"Cloud Functions","count":19},{"language":"en","tag":"Scheduled Functions","count":18},{"language":"es","tag":"Funciones programadas","count":18},{"language":"en","tag":"Inbound router","count":14},{"language":"en","tag":"Meetings","count":14},{"language":"en","tag":"Support reference","count":14},{"language":"es","tag":"Enrutador de entrada","count":14},{"language":"es","tag":"Reuniones","count":14},{"language":"es","tag":"Referencia de soporte","count":14},{"language":"en","tag":"Integrations","count":13},{"language":"es","tag":"Integraciones","count":13}]},"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":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"docs/en/api/workflows/create-workflow","slug":"/docs/en/api/workflows/create-workflow","pageMetadata":{"title":"Create an Agent","sidebarTitle":"Create","description":"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.","openapi":"openapi.json POST /workflows","href":"/docs/en/api/workflows/create-workflow"},"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: \"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(`span`,{class:`badge--post`,children:`POST`}),`\n`,_jsx(`code`,{class:`endpoint-url`,children:`/workflows`}),`\n`,_jsx(_components.p,{children:`Create a new agent (funnel + statuses) from scratch — entirely via API. This is the first step in the API-first agent lifecycle:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Create`}),` the agent (this endpoint). It’s born `,_jsx(_components.strong,{children:`paused`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/docs/en/api/workflows/set-workflow-prompt`,children:`Set its prompt`}),` — what it says and how it behaves.`]}),`\n`,_jsxs(_components.li,{children:[`Optionally `,_jsx(_components.a,{href:`/docs/en/api/workflows/update-workflow-structure`,children:`add custom statuses/fields`}),` or `,_jsx(_components.a,{href:`/docs/en/api/workflow-tools/create-workflow-tool`,children:`custom tools`}),` it can call.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/docs/en/api/workflows/update-workflow`,children:`Activate it`}),` by setting `,_jsx(_components.code,{children:`is_paused: false`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Idempotent.`}),` If an agent with the same `,_jsx(_components.code,{children:`name`}),` already exists on your account, this returns the existing one (`,_jsx(_components.code,{children:`status: \"existed\"`}),`) instead of creating a duplicate — safe to retry.`]}),`\n`,_jsx(Heading,{level:`2`,id:`customer-content-limit`,children:`Customer content limit`}),`\n`,_jsxs(_components.p,{children:[`Each task has a maximum of `,_jsx(_components.strong,{children:`20,000 customer tokens`}),`, including its shared identity when it belongs to an agent. Nexor’s internal instructions do not use this allowance, but a task that takes calls also has a 28,000-token call limit that includes them. The limit covers the task configuration described in `,_jsx(_components.a,{href:`/docs/en/guides/agents/prompt-best-practices#your-content-limit`,children:`Your content limit`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The API returns `,_jsx(_components.code,{children:`422 CUSTOMER_PROMPT_TOO_LARGE`}),` when the resulting customer configuration exceeds this limit. If a call would exceed the call limit, it returns `,_jsx(_components.code,{children:`503 VOICE_PROMPT_CAPACITY_EXCEEDED`}),` with `,_jsx(_components.code,{children:`capacity.tokens`}),` and `,_jsx(_components.code,{children:`capacity.limit`}),`. Shorten the prompt or instructions by at least `,_jsx(_components.code,{children:`capacity.tokens - capacity.limit`}),` tokens. Creation can involve several writes, so read the current task state before retrying a failed request.`]}),`\n`,_jsxs(_components.p,{children:[`If the task’s call flow would exceed `,_jsx(_components.strong,{children:`390,000 bytes`}),`, the API returns `,_jsx(_components.code,{children:`422 CONVERSATION_FLOW_TOO_LARGE`}),` with `,_jsx(_components.code,{children:`projected_bytes`}),`, `,_jsx(_components.code,{children:`limit`}),`, and the parts that drive its size. If the call flow cannot be built from the configuration, it returns `,_jsx(_components.code,{children:`422 CONVERSATION_FLOW_CONFIGURATION_INVALID`}),` with a `,_jsx(_components.code,{children:`reason`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request Body`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Yes`})}),_jsx(_components.td,{children:`Agent name. Used for the idempotency check`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`goal_type`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Yes`})}),_jsxs(_components.td,{children:[`One of the values in `,_jsx(_components.a,{href:`#available-goals`,children:`Available goals`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`statuses`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Yes`})}),_jsxs(_components.td,{children:[`Non-empty array of funnel statuses (see below). If none is marked `,_jsx(_components.code,{children:`is_initial`}),`, the first one is used; if none is marked `,_jsx(_components.code,{children:`is_terminal`}),`, the last one is used`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`description`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Agent description`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`global_prompt`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Base prompt. You can also set this later via `,_jsx(_components.code,{children:`PATCH /workflows/:id/prompt`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`language`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Default `,_jsx(_components.code,{children:`es`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`channels`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Channels to enable, e.g. `,_jsx(_components.code,{children:`[\"whatsapp\", \"email\"]`}),`. Default `,_jsx(_components.code,{children:`[\"whatsapp\"]`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`fields`})}),_jsx(_components.td,{children:`array`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Custom lead fields to collect (see `,_jsx(_components.a,{href:`/docs/en/api/workflows/update-workflow-structure`,children:`Update Structure`}),` for the shape). A `,_jsx(_components.code,{children:`select`}),` or `,_jsx(_components.code,{children:`multiselect`}),` field needs at least one option that is not blank in `,_jsx(_components.code,{children:`options`}),`; without one it is saved as `,_jsx(_components.code,{children:`text`}),` and listed in `,_jsx(_components.code,{children:`coerced_fields`})]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`available-goals`,children:`Available goals`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`goal_type`})}),_jsx(_components.th,{children:`Expected outcome`}),_jsx(_components.th,{children:`Notes`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`appointment`})}),_jsx(_components.td,{children:`Book a meeting`}),_jsx(_components.td,{children:`Enables calendar capabilities.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`payment_link`})}),_jsx(_components.td,{children:`Send a payment link and complete payment`}),_jsx(_components.td,{children:`The integration that creates or supplies the link must be configured.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`qualification`})}),_jsx(_components.td,{children:`Qualify the lead from collected data`}),_jsx(_components.td,{children:`Pair it with fields and stages that express the criteria.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`information`})}),_jsx(_components.td,{children:`Answer questions`}),_jsx(_components.td,{children:`Usually depends on a knowledge base.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`support`})}),_jsx(_components.td,{children:`Resolve or escalate support requests`}),_jsx(_components.td,{children:`Define explicit escalation rules.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`document_collection`})}),_jsx(_components.td,{children:`Request and verify documents`}),_jsxs(_components.td,{children:[`The dashboard shows a `,_jsx(_components.strong,{children:`Documents`}),` section for this goal.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`quote`})}),_jsx(_components.td,{children:`Generate a quote from a catalog`}),_jsx(_components.td,{children:`Requires an assigned catalog.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`custom`})}),_jsx(_components.td,{children:`Achieve an operator-written objective`}),_jsx(_components.td,{children:`Does not enable calendar tools.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sale`})}),_jsx(_components.td,{children:`Complete a sale`}),_jsx(_components.td,{children:`API-compatible value; it is not a preset in the current dashboard picker.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Onboarding also offers `,_jsx(_components.strong,{children:`Qualify, then book`}),`. That option is stored as `,_jsx(_components.code,{children:`appointment`}),` with a qualification pipeline and rules; do not send `,_jsx(_components.code,{children:`qualify_then_book`}),` to this public endpoint.`]})}),`\n`,_jsxs(Heading,{level:`3`,id:`the-custom-goal`,children:[`The `,_jsx(_components.code,{children:`custom`}),` goal`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`custom`}),` when the agent’s objective is not one of the preset goals — debt collection, client win-back, post-sale follow-up, or surveys. The agent pursues an `,_jsx(_components.strong,{children:`objective written in the operator’s own words`}),`, configured in the Dashboard under `,_jsx(_components.strong,{children:`Agent settings → Goal`}),` and stored as `,_jsx(_components.code,{children:`config.goal_statement`}),`. It accepts up to 600 characters and should describe the outcome, not the procedure. Two things to know:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A `,_jsx(_components.code,{children:`custom`}),` agent `,_jsx(_components.strong,{children:`does not schedule meetings`}),` — the calendar tools are not available to it. If the goal ends in a booked meeting, use `,_jsx(_components.code,{children:`appointment`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`You must send `,_jsx(_components.code,{children:`statuses`}),` as with every other goal. This endpoint does not infer the pipeline; a typical custom setup can use `,_jsx(_components.code,{children:`new → contacted → engaged → converted → lost`}),` with transition instructions adapted to the written outcome.`]}),`\n`]}),`\n`,_jsxs(Heading,{level:`3`,id:`statuses-shape`,children:[_jsx(_components.code,{children:`statuses[]`}),` shape`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`key`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Yes`})}),_jsx(_components.td,{children:`Stable identifier for the status`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:_jsx(_components.strong,{children:`Yes`})}),_jsxs(_components.td,{children:[`Display label (`,_jsx(_components.code,{children:`label`}),` also accepted)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`is_initial`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Marks the funnel’s entry status`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`is_terminal`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Marks a funnel-ending status`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sort_order`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Defaults to array index`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`responses`,children:`Responses`}),`\n`,_jsxs(Heading,{level:`3`,id:`201-—-agent-created`,children:[_jsx(_components.code,{children:`201`}),` — Agent created`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"workflow_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"123e4567-e89b-12d3-a456-426614174000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"created\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`If a `,_jsx(_components.code,{children:`select`}),` or `,_jsx(_components.code,{children:`multiselect`}),` field in `,_jsx(_components.code,{children:`fields`}),` had no usable option, Nexor saves it as `,_jsx(_components.code,{children:`text`}),` and adds `,_jsx(_components.code,{children:`coerced_fields`}),` to the response. Each entry has the field’s `,_jsx(_components.code,{children:`key`}),`, `,_jsx(_components.code,{children:`requested_type`}),`, `,_jsx(_components.code,{children:`saved_type`}),` (`,_jsx(_components.code,{children:`text`}),`), `,_jsx(_components.code,{children:`reason`}),` (`,_jsx(_components.code,{children:`no_options`}),`), and a `,_jsx(_components.code,{children:`hint`}),`. To make the field a list, send it to `,_jsx(_components.a,{href:`/docs/en/api/workflows/update-workflow-structure#list-fields`,children:`Update Structure`}),` with `,_jsx(_components.code,{children:`type`}),` set to `,_jsx(_components.code,{children:`select`}),` or `,_jsx(_components.code,{children:`multiselect`}),` and a non-empty `,_jsx(_components.code,{children:`options`}),` array.`]}),`\n`,_jsxs(Heading,{level:`3`,id:`200-—-already-existed-idempotent-replay`,children:[_jsx(_components.code,{children:`200`}),` — Already existed (idempotent replay)`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"workflow_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"123e4567-e89b-12d3-a456-426614174000\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"existed\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Heading,{level:`3`,id:`400-—-validation-error`,children:[_jsx(_components.code,{children:`400`}),` — Validation error`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Invalid input\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"name is required\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Other validation errors:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`\"goal_type must be one of: appointment, sale, qualification, information, payment_link, support, custom, quote, document_collection\"`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`\"statuses must be a non-empty array\"`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`\"each status needs a key and a name\"`})}),`\n`]}),`\n`,_jsxs(Heading,{level:`3`,id:`401-—-authentication-error`,children:[_jsx(_components.code,{children:`401`}),` — Authentication error`]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/docs/en/api/authentication`,children:`Authentication`}),`.`]}),`\n`,_jsxs(Heading,{level:`3`,id:`503-—-validation-unavailable`,children:[_jsx(_components.code,{children:`503`}),` — Validation unavailable`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`503 VOICE_PROMPT_BUDGET_UNAVAILABLE`}),` means Nexor could not complete the capacity check. Retry when validation is available.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an Agent","sidebarTitle":"Create","description":"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.","openapi":"openapi.json POST /workflows","href":"/docs/en/api/workflows/create-workflow"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Customer content limit","slug":"customer-content-limit","depth":2,"children":[]},{"title":"Request Body","slug":"request-body","depth":2,"children":[{"title":"Available goals","slug":"available-goals","depth":3,"children":[]},{"title":"The custom goal","slug":"the-custom-goal","depth":3,"children":[]},{"title":"statuses[] shape","slug":"statuses-shape","depth":3,"children":[]}]},{"title":"Responses","slug":"responses","depth":2,"children":[{"title":"201 — Agent created","slug":"201-—-agent-created","depth":3,"children":[]},{"title":"200 — Already existed (idempotent replay)","slug":"200-—-already-existed-idempotent-replay","depth":3,"children":[]},{"title":"400 — Validation error","slug":"400-—-validation-error","depth":3,"children":[]},{"title":"401 — Authentication error","slug":"401-—-authentication-error","depth":3,"children":[]},{"title":"503 — Validation unavailable","slug":"503-—-validation-unavailable","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create an Agent","description":"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.","operationId":"postWorkflows","tags":["Agents"],"responses":{"200":"2f09f1af-e547-4b12-9eed-3b17d7517c1d","201":"8241db1f-0957-4aff-97c9-b983bb38da4a","400":"ccb0c9c1-cee1-4134-b79b-ecb6e1e74542","401":"361371b3-b761-445f-a6fb-5f692ce4c80e","403":"06cd2214-25ef-4ee6-9f86-8407b1c9051b","404":"edc8880d-0349-4bc0-b674-643f8937bd08","409":"939198b9-03ea-48bb-b031-5d62f3e204ab","422":"b7cbf040-4117-44f8-80cd-326bf156ec14","429":"7e1ff64f-2439-42df-8066-a64d2b1b14c0","500":"baf2670d-05fe-41bc-b1ce-1cc8af004319","503":"63c878e7-4952-4ae5-b201-828606a87ba5"},"x-docs":{"group":"Agents","path":"api/workflows/create-workflow","pageMode":"existing-bind","contractDetail":"handler-derived-top-level","source":{"repo":"nexor-node-api","sha":"acd1e9d6f19b23177d05408eb712f6d1f047fcfc","file":"src/features/public-api/public-workflows.routes.js","line":319,"factory":"createPublicWorkflowsRouter","mount":"/api/public/workflows","localPath":"/"},"scope":"workflows:write","auth":{"credential":"X-API-Key or Authorization Bearer API key","audience":"tenant_customer"},"observed":{"body_fields":["agent_name","agent_role","begin_message","channels","company_name","description","fields","global_prompt","goal_type","language","master_workflow_id","name","region_style","statuses","timezone"],"required_body_fields":["goal_type","name","statuses"],"required_body_fields_by_variant":[],"request_body_required":true,"query_fields":[],"required_query_fields":[],"response_codes":[200,201,400,404,409,422,500,503],"response_fields_by_code":{"200":["master_workflow_id","status","success","workflow_id"],"201":["coerced_fields","language","master_workflow_id","region_style","status","success","timezone","workflow_id"],"400":["code","error","message"],"404":["code","error","message"],"409":["code","error","message"],"422":["content_bytes","customer","error","exits","fields","limit","phases","projected_bytes","reason","reroute_targets","tokens","tools","transfers","workflow_id"],"500":["code","error","message"],"503":["capacity","customer","error","message"]},"path_fields":[],"required_path_fields":[]},"en":{"path":"docs/en/api/workflows/create-workflow","title":"Create an Agent","sidebarTitle":"Create","description":"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open."},"es":{"path":"docs/es/api/workflows/create-workflow","title":"Crear un agente","sidebarTitle":"Crear","description":"Esta operación permite crear un agente en la cuenta autenticada de Nexor. Esta referencia documenta campos verificados de ruta, consulta y cuerpo JSON de nivel superior, códigos de estado observados y campos de respuesta de nivel superior. Las respuestas del proveedor o con estructuras anidadas profundas pueden permanecer abiertas."},"contractSource":{"artifact":"phase9-contracts-workflows-templates.json","sha256":"a4cfab8dd2d49077a62e7dc1b8aa52edada619b31e237b1dd1c46ab11ab82880","node_sha":"0489d6ae8f42220d3e445c6b09c6da3de3981c1e","evidence":["src/features/public-api/public-workflows.routes.js:317-519","src/features/wizard/schema.js:9-9","src/features/ai-agent/i18n/data/retell-languages.js:64-84"]},"safety":{"contract":null,"securityReview":{"decision":"publish","warning_codes":[],"notes":[],"evidence":["node@0489d6ae8f42220d3e445c6b09c6da3de3981c1e:src/features/ai-agent/i18n/data/retell-languages.js:64-84","node@0489d6ae8f42220d3e445c6b09c6da3de3981c1e:src/features/public-api/public-workflows.routes.js:317-519","node@0489d6ae8f42220d3e445c6b09c6da3de3981c1e:src/features/public-api/public-workflows.routes.js:318","node@0489d6ae8f42220d3e445c6b09c6da3de3981c1e:src/features/wizard/schema.js:9-9"]}}},"parameters":[],"requestBody":"7c614983-3948-4e94-bd4b-c4010f7ea898","method":"post","type":"path","servers":["5c88c5ae-afbe-4d33-b16e-710cb9d2baa8"],"security":["2401f0d1-5a36-4e43-97cb-c2d97e69a8f2"],"path":"/workflows","baseUrlOptions":["https://api.getnexor.ai/api/public"],"title":"Create an Agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.name":"\u003cstring>","body.statuses.items.0.oneOf.0.key":"\u003cstring>","body.statuses.items.0.oneOf.0.name":"\u003cstring>","body.statuses.items.0.oneOf.0.label":"\u003cstring>","body.statuses.items.0.oneOf.0.is_initial":false,"body.statuses.items.0.oneOf.0.is_terminal":false,"body.statuses.items.0.oneOf.0.sort_order":123,"body.statuses.items.0.oneOf.0.entry_hint.oneOf.0":"\u003cstring>","body.statuses.items.0.oneOf.0.category.oneOf.0":"\u003cstring>","body.statuses.items.0.oneOf.0.color":"\u003cstring>","body.statuses.items.0.oneOf.0.is_auto_contacted":false,"body.statuses.items.0.oneOf.0.is_auto_engaged":false,"body.statuses.items.0.oneOf.0.is_booking_target":false,"body.statuses.items.0.oneOf.0.is_qualified":false,"body.statuses.items.0.oneOf.0.requires_all_fields":false,"body.statuses.items.0.oneOf.0.pause_bot":false,"body.statuses.items.0.oneOf.0.required_field_keys.oneOf.0.items.0":"\u003cstring>","body.statuses.items.0.oneOf.0.transition_rules.oneOf.0":{},"body.statuses.items.0.oneOf.0.timeout_config.oneOf.0.timeout.oneOf.0":1,"body.statuses.items.0.oneOf.0.timeout_config.oneOf.0.target_status_key":"\u003cstring>","body.statuses.items.0.oneOf.0.transfer_config.oneOf.0.target_workflow_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","body.statuses.items.0.oneOf.0.transfer_config.oneOf.0.target_status_key.oneOf.0":"\u003cstring>","body.statuses.items.0.oneOf.0.transfer_config.oneOf.0.copy_fields":true,"body.statuses.items.0.oneOf.0.transfer_config.oneOf.0.silent":true,"body.statuses.items.0.oneOf.0.assignment_config.oneOf.0":{},"body.master_workflow_id.oneOf.0":"3c90c3cc-0d44-4b50-8888-8dd25736052a","body.agent_name.oneOf.0":"\u003cstring>","body.agent_role.oneOf.0":"\u003cstring>","body.company_name.oneOf.0":"\u003cstring>","body.begin_message.oneOf.0":"\u003cstring>","body.timezone":"\u003cstring>","body.global_prompt":"\u003cstring>","body.fields.items.0.key":"\u003cstring>","body.fields.items.0.label":"\u003cstring>","body.fields.items.0.type":"text","body.fields.items.0.required":false,"body.fields.items.0.options.oneOf.0.items.0.oneOf.0":"\u003cstring>","body.fields.items.0.extraction_hints":"\u003cstring>","body.fields.items.0.sort_order":123,"body.fields.items.0.metadata_key.oneOf.0":"\u003cstring>","body.description.oneOf.0":"\u003cstring>"}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"goal_type":{"type":"string","enum":["appointment","sale","qualification","information","payment_link","support","custom","quote","document_collection"],"isRequired":true,"uniqueKey":"goal_type","typeLabel":"enum\u003cstring>"},"statuses":{"type":"array","items":{"oneOf":[{"type":"object","required":["key","name"],"properties":{"key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.key","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.name","typeLabel":"string"},"label":{"type":"string","minLength":1,"uniqueKey":"statuses.items.[INDEX].oneOf.0.label","typeLabel":"string"},"is_initial":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.is_initial","typeLabel":"boolean"},"is_terminal":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.is_terminal","typeLabel":"boolean"},"sort_order":{"type":"number","uniqueKey":"statuses.items.[INDEX].oneOf.0.sort_order","typeLabel":"number"},"entry_hint":{"oneOf":[{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.0.entry_hint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"statuses.items.[INDEX].oneOf.0.entry_hint.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.entry_hint","typeLabel":"string | null"},"category":{"oneOf":[{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.0.category.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"statuses.items.[INDEX].oneOf.0.category.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.category","typeLabel":"string | null"},"color":{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.0.color","typeLabel":"string"},"is_auto_contacted":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.is_auto_contacted","typeLabel":"boolean"},"is_auto_engaged":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.is_auto_engaged","typeLabel":"boolean"},"is_booking_target":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.is_booking_target","typeLabel":"boolean"},"is_qualified":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.is_qualified","typeLabel":"boolean"},"requires_all_fields":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.requires_all_fields","typeLabel":"boolean"},"pause_bot":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.0.pause_bot","typeLabel":"boolean"},"required_field_keys":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.0.required_field_keys.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"statuses.items.[INDEX].oneOf.0.required_field_keys.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"statuses.items.[INDEX].oneOf.0.required_field_keys.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.required_field_keys","typeLabel":"string[] | null"},"transition_rules":{"oneOf":[{"type":"object","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.transition_rules.oneOf.0","typeLabel":"object"},{"type":"null","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.transition_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.transition_rules","typeLabel":"object | null"},"timeout_config":{"oneOf":[{"type":"object","properties":{"timeout":{"oneOf":[{"type":"number","minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config.oneOf.0.timeout.oneOf.0","typeLabel":"number"},{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config.oneOf.0.timeout.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config.oneOf.0.timeout","typeLabel":"number | string"},"unit":{"type":"string","enum":["minutes","hours","days"],"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config.oneOf.0.unit","typeLabel":"enum\u003cstring>"},"target_status_key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config.oneOf.0.target_status_key","typeLabel":"string"}},"required":["timeout","unit","target_status_key"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"timeout":{"oneOf":[{"type":"number","minimum":0,"exclusiveMinimum":true},{"type":"string","minLength":1}]},"unit":{"type":"string","enum":["minutes","hours","days"]},"target_status_key":{"type":"string","minLength":1}},"required":["timeout","unit","target_status_key"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.timeout_config","typeLabel":"object | null"},"transfer_config":{"oneOf":[{"type":"object","properties":{"target_workflow_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.0.target_workflow_id","typeLabel":"string\u003cuuid>"},"target_status_key":{"oneOf":[{"type":"string","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage.","uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.0.target_status_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage.","uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.0.target_status_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.0.target_status_key","typeLabel":"string | null"},"copy_fields":{"type":"boolean","description":"`true`: copies each value the source task collected into the receiving task's variable with the same key. Omitted or `false`: nothing is copied into variables. Either way, the receiving task's context includes a snapshot of the collected fields.","uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.0.copy_fields","typeLabel":"boolean"},"silent":{"type":"boolean","description":"Text channels only (WhatsApp, Instagram, Messenger, SMS, email, Web Chat, iMessage). `true`: the receiving task sends nothing when the lead is transferred, starts no contact cadence, and answers when the lead writes. Omitted or `false`: the usual transfer behavior applies. A non-boolean value returns 400 `transfer_silent_invalid`.","uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.0.silent","typeLabel":"boolean"}},"required":["target_workflow_id"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"target_workflow_id":{"type":"string","format":"uuid"},"target_status_key":{"oneOf":[{"type":"string","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage."},{"type":"null","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage."}]},"copy_fields":{"type":"boolean","description":"`true`: copies each value the source task collected into the receiving task's variable with the same key. Omitted or `false`: nothing is copied into variables. Either way, the receiving task's context includes a snapshot of the collected fields."},"silent":{"type":"boolean","description":"Text channels only (WhatsApp, Instagram, Messenger, SMS, email, Web Chat, iMessage). `true`: the receiving task sends nothing when the lead is transferred, starts no contact cadence, and answers when the lead writes. Omitted or `false`: the usual transfer behavior applies. A non-boolean value returns 400 `transfer_silent_invalid`."}},"required":["target_workflow_id"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.transfer_config","typeLabel":"object | null"},"assignment_config":{"oneOf":[{"type":"object","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.assignment_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0.assignment_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.0.assignment_config","typeLabel":"object | null"}},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["key","label"],"properties":{"key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.key","typeLabel":"string"},"label":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.label","typeLabel":"string"},"name":{"type":"string","minLength":1,"uniqueKey":"statuses.items.[INDEX].oneOf.1.name","typeLabel":"string"},"is_initial":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.is_initial","typeLabel":"boolean"},"is_terminal":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.is_terminal","typeLabel":"boolean"},"sort_order":{"type":"number","uniqueKey":"statuses.items.[INDEX].oneOf.1.sort_order","typeLabel":"number"},"entry_hint":{"oneOf":[{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.1.entry_hint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"statuses.items.[INDEX].oneOf.1.entry_hint.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.entry_hint","typeLabel":"string | null"},"category":{"oneOf":[{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.1.category.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"statuses.items.[INDEX].oneOf.1.category.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.category","typeLabel":"string | null"},"color":{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.1.color","typeLabel":"string"},"is_auto_contacted":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.is_auto_contacted","typeLabel":"boolean"},"is_auto_engaged":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.is_auto_engaged","typeLabel":"boolean"},"is_booking_target":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.is_booking_target","typeLabel":"boolean"},"is_qualified":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.is_qualified","typeLabel":"boolean"},"requires_all_fields":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.requires_all_fields","typeLabel":"boolean"},"pause_bot":{"type":"boolean","default":false,"uniqueKey":"statuses.items.[INDEX].oneOf.1.pause_bot","typeLabel":"boolean"},"required_field_keys":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"statuses.items.[INDEX].oneOf.1.required_field_keys.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"statuses.items.[INDEX].oneOf.1.required_field_keys.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"statuses.items.[INDEX].oneOf.1.required_field_keys.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.required_field_keys","typeLabel":"string[] | null"},"transition_rules":{"oneOf":[{"type":"object","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.transition_rules.oneOf.0","typeLabel":"object"},{"type":"null","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.transition_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.transition_rules","typeLabel":"object | null"},"timeout_config":{"oneOf":[{"type":"object","properties":{"timeout":{"oneOf":[{"type":"number","minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config.oneOf.0.timeout.oneOf.0","typeLabel":"number"},{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config.oneOf.0.timeout.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config.oneOf.0.timeout","typeLabel":"number | string"},"unit":{"type":"string","enum":["minutes","hours","days"],"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config.oneOf.0.unit","typeLabel":"enum\u003cstring>"},"target_status_key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config.oneOf.0.target_status_key","typeLabel":"string"}},"required":["timeout","unit","target_status_key"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"timeout":{"oneOf":[{"type":"number","minimum":0,"exclusiveMinimum":true},{"type":"string","minLength":1}]},"unit":{"type":"string","enum":["minutes","hours","days"]},"target_status_key":{"type":"string","minLength":1}},"required":["timeout","unit","target_status_key"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.timeout_config","typeLabel":"object | null"},"transfer_config":{"oneOf":[{"type":"object","properties":{"target_workflow_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.0.target_workflow_id","typeLabel":"string\u003cuuid>"},"target_status_key":{"oneOf":[{"type":"string","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage.","uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.0.target_status_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage.","uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.0.target_status_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.0.target_status_key","typeLabel":"string | null"},"copy_fields":{"type":"boolean","description":"`true`: copies each value the source task collected into the receiving task's variable with the same key. Omitted or `false`: nothing is copied into variables. Either way, the receiving task's context includes a snapshot of the collected fields.","uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.0.copy_fields","typeLabel":"boolean"},"silent":{"type":"boolean","description":"Text channels only (WhatsApp, Instagram, Messenger, SMS, email, Web Chat, iMessage). `true`: the receiving task sends nothing when the lead is transferred, starts no contact cadence, and answers when the lead writes. Omitted or `false`: the usual transfer behavior applies. A non-boolean value returns 400 `transfer_silent_invalid`.","uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.0.silent","typeLabel":"boolean"}},"required":["target_workflow_id"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"target_workflow_id":{"type":"string","format":"uuid"},"target_status_key":{"oneOf":[{"type":"string","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage."},{"type":"null","description":"Key of the stage in the receiving task where the lead starts (the Landing stage). Omitted, null, or blank: the first stage. It must be an open stage of the receiving task: not terminal, won, or lost, not the goal stage, not a stage that pauses the agent, and not a stage with its own transfer. Otherwise, or when the value is not a string, the request returns 400 `transfer_target_status_invalid`. If the stage no longer qualifies when the transfer runs, or its owner assignment has no eligible member, the lead starts in the first stage."}]},"copy_fields":{"type":"boolean","description":"`true`: copies each value the source task collected into the receiving task's variable with the same key. Omitted or `false`: nothing is copied into variables. Either way, the receiving task's context includes a snapshot of the collected fields."},"silent":{"type":"boolean","description":"Text channels only (WhatsApp, Instagram, Messenger, SMS, email, Web Chat, iMessage). `true`: the receiving task sends nothing when the lead is transferred, starts no contact cadence, and answers when the lead writes. Omitted or `false`: the usual transfer behavior applies. A non-boolean value returns 400 `transfer_silent_invalid`."}},"required":["target_workflow_id"],"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.transfer_config","typeLabel":"object | null"},"assignment_config":{"oneOf":[{"type":"object","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.assignment_config.oneOf.0","typeLabel":"object"},{"type":"null","properties":{},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1.assignment_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"statuses.items.[INDEX].oneOf.1.assignment_config","typeLabel":"object | null"}},"additionalProperties":true,"uniqueKey":"statuses.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"statuses.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"statuses","typeLabel":"object[]"},"master_workflow_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"master_workflow_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"master_workflow_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"master_workflow_id","typeLabel":"string\u003cuuid> | null"},"language":{"type":"string","enum":["es-CL","es-MX","es-PE","es-CO","es-AR","es-US","en-US","en-AU","ko-KR","pt-BR","fr-FR","ar-AE","zh-CN","vi-VN","th-TH"],"uniqueKey":"language","typeLabel":"enum\u003cstring>"},"agent_name":{"oneOf":[{"type":"string","maxLength":200,"uniqueKey":"agent_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"uniqueKey":"agent_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"agent_name","typeLabel":"string | null"},"agent_role":{"oneOf":[{"type":"string","maxLength":200,"uniqueKey":"agent_role.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"uniqueKey":"agent_role.oneOf.1","typeLabel":"null"}],"uniqueKey":"agent_role","typeLabel":"string | null"},"company_name":{"oneOf":[{"type":"string","maxLength":200,"uniqueKey":"company_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"uniqueKey":"company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"company_name","typeLabel":"string | null"},"begin_message":{"oneOf":[{"type":"string","maxLength":1000,"uniqueKey":"begin_message.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1000,"uniqueKey":"begin_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"begin_message","typeLabel":"string | null"},"timezone":{"type":"string","description":"Valid IANA time-zone name.","uniqueKey":"timezone","typeLabel":"string"},"region_style":{"type":"string","enum":["cl","mx","pe","co","ar","es","latam","us","au","gb","in","nz","kr","br","pt"],"uniqueKey":"region_style","typeLabel":"enum\u003cstring>"},"global_prompt":{"type":"string","uniqueKey":"global_prompt","typeLabel":"string"},"channels":{"type":"array","items":{"type":"string","enum":["whatsapp","call","voice","retell","email","sms"],"uniqueKey":"channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"channels","typeLabel":"enum\u003cstring>[]"},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"fields.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"fields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","number","date","datetime","boolean","select","multiselect","email","phone","url","currency"],"default":"text","uniqueKey":"fields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","default":false,"uniqueKey":"fields.items.[INDEX].required","typeLabel":"boolean"},"options":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"string","description":"One choice of a `select` or `multiselect` field: a string, or an object with the stored `value` and an optional display `label`. When you send options, a string must not be empty.","uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"One choice of a `select` or `multiselect` field: a string, or an object with the stored `value` and an optional display `label`. When you send options, a string must not be empty.","required":["value"],"properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX].oneOf.1.value","typeLabel":"string"},"label":{"type":"string","uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX].oneOf.1.label","typeLabel":"string"}},"uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"fields.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"string | object"},"description":"Choices for a `select` or `multiselect` field. A usable option is a string that is not blank, or an object whose `value` is a string that is not blank. A `select` or `multiselect` field sent with no usable option is saved as `text` with `options` set to null and listed in `coerced_fields`.","uniqueKey":"fields.items.[INDEX].options.oneOf.0","typeLabel":"(string | object)[]"},{"type":"null","items":{"oneOf":[{"type":"string","description":"One choice of a `select` or `multiselect` field: a string, or an object with the stored `value` and an optional display `label`. When you send options, a string must not be empty."},{"type":"object","description":"One choice of a `select` or `multiselect` field: a string, or an object with the stored `value` and an optional display `label`. When you send options, a string must not be empty.","required":["value"],"properties":{"value":{"type":"string"},"label":{"type":"string"}}}]},"description":"Choices for a `select` or `multiselect` field. A usable option is a string that is not blank, or an object whose `value` is a string that is not blank. A `select` or `multiselect` field sent with no usable option is saved as `text` with `options` set to null and listed in `coerced_fields`.","uniqueKey":"fields.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.items.[INDEX].options","typeLabel":"(string | object)[] | null"},"extraction_hints":{"type":"string","uniqueKey":"fields.items.[INDEX].extraction_hints","typeLabel":"string"},"sort_order":{"type":"number","uniqueKey":"fields.items.[INDEX].sort_order","typeLabel":"number"},"metadata_key":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9_]+(?:\\.[A-Za-z0-9_]+)*$","description":"Lead metadata key or dot-separated path that prefills this field.","uniqueKey":"fields.items.[INDEX].metadata_key.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9_]+(?:\\.[A-Za-z0-9_]+)*$","description":"Lead metadata key or dot-separated path that prefills this field.","uniqueKey":"fields.items.[INDEX].metadata_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.items.[INDEX].metadata_key","typeLabel":"string | null"},"intake_value_map":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"fields.items.[INDEX].intake_value_map.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Incoming-string to canonical-field-value normalization map.","uniqueKey":"fields.items.[INDEX].intake_value_map.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"fields.items.[INDEX].intake_value_map.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Incoming-string to canonical-field-value normalization map.","uniqueKey":"fields.items.[INDEX].intake_value_map.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.items.[INDEX].intake_value_map","typeLabel":"object | null"}},"required":["key","label"],"additionalProperties":true,"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields","typeLabel":"object[]"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"}},"required":["name","goal_type","statuses"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","statuses":[{"key":"\u003cstring>","name":"\u003cstring>","label":"\u003cstring>","is_initial":false,"is_terminal":false,"sort_order":123,"entry_hint":"\u003cstring>","category":"\u003cstring>","color":"\u003cstring>","is_auto_contacted":false,"is_auto_engaged":false,"is_booking_target":false,"is_qualified":false,"requires_all_fields":false,"pause_bot":false,"required_field_keys":["\u003cstring>"],"transition_rules":{},"timeout_config":{"timeout":1,"target_status_key":"\u003cstring>"},"transfer_config":{"target_workflow_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","target_status_key":"\u003cstring>","copy_fields":true,"silent":true},"assignment_config":{}}],"master_workflow_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","agent_name":"\u003cstring>","agent_role":"\u003cstring>","company_name":"\u003cstring>","begin_message":"\u003cstring>","timezone":"\u003cstring>","global_prompt":"\u003cstring>","channels":[],"fields":[{"key":"\u003cstring>","label":"\u003cstring>","type":"text","required":false,"options":["\u003cstring>"],"extraction_hints":"\u003cstring>","sort_order":123,"metadata_key":"\u003cstring>","intake_value_map":{}}],"description":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2f09f1af-e547-4b12-9eed-3b17d7517c1d":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"workflow_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"workflow_id","typeLabel":"string\u003cuuid>"},"master_workflow_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"master_workflow_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"master_workflow_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"master_workflow_id","typeLabel":"string\u003cuuid> | null"},"status":{"type":"string","enum":["existed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"required":["success","workflow_id","master_workflow_id","status"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"workflow_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","master_workflow_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"existed"}}},"exampleType":"generated"}},"exampleType":"generated"},"8241db1f-0957-4aff-97c9-b983bb38da4a":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"workflow_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"workflow_id","typeLabel":"string\u003cuuid>"},"master_workflow_id":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"master_workflow_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"master_workflow_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"master_workflow_id","typeLabel":"string\u003cuuid> | null"},"status":{"type":"string","enum":["created"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"language":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"language.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"language","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"timezone.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"timezone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"timezone","typeLabel":"string | null"},"region_style":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"region_style.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"region_style.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"region_style","typeLabel":"string | null"},"coerced_fields":{"type":"array","items":{"type":"object","description":"A field that was sent as `select` or `multiselect` with no usable option and was saved as `text`. To make it a list, send it again with `type` set to `select` or `multiselect` and a non-empty `options` array.","properties":{"key":{"type":"string","description":"Key of the field.","isRequired":true,"uniqueKey":"coerced_fields.items.[INDEX].key","typeLabel":"string"},"requested_type":{"type":"string","enum":["select","multiselect"],"isRequired":true,"uniqueKey":"coerced_fields.items.[INDEX].requested_type","typeLabel":"enum\u003cstring>"},"saved_type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"coerced_fields.items.[INDEX].saved_type","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["no_options"],"isRequired":true,"uniqueKey":"coerced_fields.items.[INDEX].reason","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"Plain-language explanation of what happened and how to fix it.","isRequired":true,"uniqueKey":"coerced_fields.items.[INDEX].hint","typeLabel":"string"}},"required":["key","requested_type","saved_type","reason","hint"],"additionalProperties":true,"example":{"key":"buyer_profile","requested_type":"select","saved_type":"text","reason":"no_options","hint":"This field was saved as text because it had no options. To make it a list, send it again with type select and a non-empty options array."},"uniqueKey":"coerced_fields.items.[INDEX]","typeLabel":"object"},"description":"Fields from `fields` that were sent as `select` or `multiselect` with no usable option and were saved as `text`. Present only when at least one field was saved this way.","uniqueKey":"coerced_fields","typeLabel":"object[]"}},"required":["success","workflow_id","master_workflow_id","status","language","timezone","region_style"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"workflow_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","master_workflow_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"created","language":"\u003cstring>","timezone":"\u003cstring>","region_style":"\u003cstring>","coerced_fields":[{"key":"buyer_profile","requested_type":"select","saved_type":"text","reason":"no_options","hint":"This field was saved as text because it had no options. To make it a list, send it again with type select and a non-empty options array."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ccb0c9c1-cee1-4134-b79b-ecb6e1e74542":{"description":"Invalid input or a protected mutation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"361371b3-b761-445f-a6fb-5f692ce4c80e":{"description":"Missing, invalid, disabled, or expired API key.","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Error type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"06cd2214-25ef-4ee6-9f86-8407b1c9051b":{"description":"The API key is not allowed to call this operation.","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Error type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"edc8880d-0349-4bc0-b674-643f8937bd08":{"description":"The tenant-scoped resource was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"939198b9-03ea-48bb-b031-5d62f3e204ab":{"description":"The requested mutation conflicts with current state. `escalation_stage_key_reserved` (code `ESCALATION_STAGE_KEY_RESERVED`): a status uses the escalation stage's reserved key (`awaiting_human_response` or `__awaiting_human_response__`) or its `system_kind`. Nexor creates that stage itself when escalation is turned on; nothing is created.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"error":"escalation_stage_key_reserved","code":"ESCALATION_STAGE_KEY_RESERVED"},"examples":{"Example":{"title":"Example","value":{"error":"escalation_stage_key_reserved","code":"ESCALATION_STAGE_KEY_RESERVED"}}},"exampleType":"examples"}},"exampleType":"examples"},"b7cbf040-4117-44f8-80cd-326bf156ec14":{"description":"Customer task configuration exceeds 20,000 tokens, including inherited shared identity. Read the current task state before retrying creation. CONVERSATION_FLOW_TOO_LARGE means the task's call flow would exceed 390,000 bytes; CONVERSATION_FLOW_CONFIGURATION_INVALID means the call flow cannot be built from the resulting configuration. Nothing is saved.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error","tokens","limit","customer"],"properties":{"error":{"type":"string","enum":["CUSTOMER_PROMPT_TOO_LARGE"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"tokens":{"type":"integer","minimum":20001,"isRequired":true,"uniqueKey":"oneOf.0.tokens","typeLabel":"integer"},"limit":{"type":"integer","enum":[20000],"isRequired":true,"uniqueKey":"oneOf.0.limit","typeLabel":"enum\u003cinteger>"},"customer":{"type":"object","required":["tokens","limit","policy_version"],"properties":{"tokens":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.customer.tokens","typeLabel":"integer"},"limit":{"type":"integer","enum":[20000],"isRequired":true,"uniqueKey":"oneOf.0.customer.limit","typeLabel":"enum\u003cinteger>"},"policy_version":{"type":"string","enum":["customer-config-v1"],"isRequired":true,"uniqueKey":"oneOf.0.customer.policy_version","typeLabel":"enum\u003cstring>"}},"description":"Customer-authored task configuration only. Nexor internal instructions are excluded.","isRequired":true,"uniqueKey":"oneOf.0.customer","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"The task's call flow would exceed the size Nexor can publish. Nothing is saved. A flow already over the limit can still shrink.","required":["error","projected_bytes","limit","phases","transfers","exits","reroute_targets","fields","tools","content_bytes"],"example":{"error":"CONVERSATION_FLOW_TOO_LARGE","projected_bytes":412345,"limit":390000,"phases":14,"transfers":3,"exits":4,"reroute_targets":5,"fields":20,"tools":6,"content_bytes":60000},"properties":{"error":{"type":"string","enum":["CONVERSATION_FLOW_TOO_LARGE"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"enum\u003cstring>"},"projected_bytes":{"type":"integer","description":"Projected size of the task's call flow after the change, in bytes.","isRequired":true,"uniqueKey":"oneOf.1.projected_bytes","typeLabel":"integer"},"limit":{"type":"integer","enum":[390000],"description":"Maximum call flow size, in bytes.","isRequired":true,"uniqueKey":"oneOf.1.limit","typeLabel":"enum\u003cinteger>"},"phases":{"type":"integer","description":"Conversation stages the call flow builds, open and won.","isRequired":true,"uniqueKey":"oneOf.1.phases","typeLabel":"integer"},"transfers":{"type":"integer","description":"Stages that transfer the call to another task.","isRequired":true,"uniqueKey":"oneOf.1.transfers","typeLabel":"integer"},"exits":{"type":"integer","description":"Terminal stages that end the conversation.","isRequired":true,"uniqueKey":"oneOf.1.exits","typeLabel":"integer"},"reroute_targets":{"type":"integer","description":"Other tasks of the agent an inbound call can be moved to.","isRequired":true,"uniqueKey":"oneOf.1.reroute_targets","typeLabel":"integer"},"fields":{"type":"integer","description":"Fields the task collects.","isRequired":true,"uniqueKey":"oneOf.1.fields","typeLabel":"integer"},"tools":{"type":"integer","description":"Tools assigned to the task.","isRequired":true,"uniqueKey":"oneOf.1.tools","typeLabel":"integer"},"content_bytes":{"type":"integer","description":"Bytes of the task's own prompts and descriptions.","isRequired":true,"uniqueKey":"oneOf.1.content_bytes","typeLabel":"integer"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"The task's call flow cannot be built from the resulting configuration. Nothing is saved. Fix the configuration named by `reason`; retrying the same request fails again.","required":["error","workflow_id","reason"],"example":{"error":"CONVERSATION_FLOW_CONFIGURATION_INVALID","workflow_id":"0e865063-80b7-4f6d-a207-f1608e112ba7","reason":"inbound_leaf_reroute_candidate_outside_group"},"properties":{"error":{"type":"string","enum":["CONVERSATION_FLOW_CONFIGURATION_INVALID"],"isRequired":true,"uniqueKey":"oneOf.2.error","typeLabel":"enum\u003cstring>"},"workflow_id":{"type":"string","format":"uuid","description":"Task whose call flow cannot be built.","isRequired":true,"uniqueKey":"oneOf.2.workflow_id","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","description":"Machine code naming the configuration problem.","isRequired":true,"uniqueKey":"oneOf.2.reason","typeLabel":"string"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"CUSTOMER_PROMPT_TOO_LARGE","tokens":20002,"limit":20000,"customer":{"tokens":1,"limit":20000,"policy_version":"customer-config-v1"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7e1ff64f-2439-42df-8066-a64d2b1b14c0":{"description":"A public API rate limit was exceeded.","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","description":"Error type","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"baf2670d-05fe-41bc-b1ce-1cc8af004319":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"63c878e7-4952-4ae5-b201-828606a87ba5":{"description":"A call for this task would exceed the call limit, which counts customer content plus Nexor's instructions and tools. Read the current task state before retrying, then shorten the prompt or instructions by at least capacity.tokens - capacity.limit tokens. Validation can also be unavailable (VOICE_PROMPT_BUDGET_UNAVAILABLE); retry when validation is available.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"A call for this task would exceed the call limit (capacity.limit), which counts customer content plus Nexor's instructions and tools. Shorten the prompt or instructions by at least capacity.tokens - capacity.limit tokens, or turn off calls if the task never calls.","required":["error","customer","capacity"],"properties":{"error":{"type":"string","enum":["VOICE_PROMPT_CAPACITY_EXCEEDED"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","required":["tokens","limit","policy_version"],"properties":{"tokens":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.customer.tokens","typeLabel":"integer"},"limit":{"type":"integer","enum":[20000],"isRequired":true,"uniqueKey":"oneOf.0.customer.limit","typeLabel":"enum\u003cinteger>"},"policy_version":{"type":"string","enum":["customer-config-v1"],"isRequired":true,"uniqueKey":"oneOf.0.customer.policy_version","typeLabel":"enum\u003cstring>"}},"description":"Customer-authored task configuration only. Nexor internal instructions are excluded.","isRequired":true,"uniqueKey":"oneOf.0.customer","typeLabel":"object"},"capacity":{"type":"object","required":["tokens","limit"],"properties":{"tokens":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.capacity.tokens","typeLabel":"integer"},"limit":{"type":"integer","enum":[28000],"isRequired":true,"uniqueKey":"oneOf.0.capacity.limit","typeLabel":"enum\u003cinteger>"}},"isRequired":true,"uniqueKey":"oneOf.0.capacity","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Call capacity validation is unavailable. Retry when validation is available.","required":["error","message"],"properties":{"error":{"type":"string","enum":["VOICE_PROMPT_BUDGET_UNAVAILABLE"],"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"VOICE_PROMPT_CAPACITY_EXCEEDED","customer":{"tokens":1,"limit":20000,"policy_version":"customer-config-v1"},"capacity":{"tokens":1,"limit":28000}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2401f0d1-5a36-4e43-97cb-c2d97e69a8f2":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Keys are prefixed with `nxr_live_`. To work inside a sub-account with a main account key, also send the optional `X-Nexor-Sub-Account-Id` header.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"5c88c5ae-afbe-4d33-b16e-710cb9d2baa8":{"url":"https://api.getnexor.ai/api/public","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Keys are prefixed with `nxr_live_`. To work inside a sub-account with a main account key, also send the optional `X-Nexor-Sub-Account-Id` header.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key for authentication. Keys are prefixed with `nxr_live_`. To work inside a sub-account with a main account key, also send the optional `X-Nexor-Sub-Account-Id` header.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"nexor","siteName":"Nexor","title":"Create an Agent - Nexor","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/docs/en/api/workflows/create-workflow","matchLevel":0},"es":{"href":"/docs/es/api/workflows/create-workflow","matchLevel":1}}},"lastModified":"2026-11-12T19:23:54.366Z","gitLastModified":"2026-11-12T19:23:26.000Z","originalFileLocation":"docs/en/api/workflows/create-workflow.md","locale":"en"},"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=\"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nexor\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nexor/LDGxX4GCDO05TtkY/_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/nexor/LDGxX4GCDO05TtkY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nexor/LDGxX4GCDO05TtkY/_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/nexor/LDGxX4GCDO05TtkY/_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/nexor/LDGxX4GCDO05TtkY/_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/nexor/LDGxX4GCDO05TtkY/_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/nexor/LDGxX4GCDO05TtkY/_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/nexor/LDGxX4GCDO05TtkY/_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/nexor/LDGxX4GCDO05TtkY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an Agent - Nexor\">\u003cmeta data-mint-head property=\"og:description\" content=\"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nexor\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nexor.mintlify.site/_mintlify/api/og/v2?division=Workflows+%28tasks%29\u0026amp;title=Create+an+Agent\u0026amp;description=This+operation+lets+you+create+an+agent+for+the+authenticated+Nexor+account.+This+reference+documents+verified+path%2C+query%2C+and+top-level+JSON+body+fields%2C+obse\u0026amp;theme=9c0e76a74db2d58e3c1a4fe5\u0026amp;signature=5ac6e0c7e7240f0077ec06161d445d882f4ffc12ed84b8958faa640d2b5993e7\">\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 - Nexor\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nexor.mintlify.site/_mintlify/api/og/v2?division=Workflows+%28tasks%29\u0026amp;title=Create+an+Agent\u0026amp;description=This+operation+lets+you+create+an+agent+for+the+authenticated+Nexor+account.+This+reference+documents+verified+path%2C+query%2C+and+top-level+JSON+body+fields%2C+obse\u0026amp;theme=9c0e76a74db2d58e3c1a4fe5\u0026amp;signature=5ac6e0c7e7240f0077ec06161d445d882f4ffc12ed84b8958faa640d2b5993e7\">\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/nexor/LDGxX4GCDO05TtkY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nexor\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/en/api/workflows/create-workflow.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.getnexor.ai/docs/es/api/workflows/create-workflow\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getnexor.ai/#organization\",\"name\":\"Nexor\",\"url\":\"https://docs.getnexor.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nexor/f1Gy8zY6i2a68PTn/images/logo-black.svg?fit=max\u0026auto=format\u0026n=f1Gy8zY6i2a68PTn\u0026q=85\u0026s=2a5ea3c97db1c6499f5f24571b593e6f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getnexor.ai#website\",\"name\":\"Nexor\",\"url\":\"https://docs.getnexor.ai\",\"publisher\":{\"@id\":\"https://docs.getnexor.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow#webpage\",\"url\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow\",\"name\":\"Create an Agent\",\"description\":\"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.\",\"dateModified\":\"2026-11-12T19:23:26.000Z\",\"isPartOf\":{\"@id\":\"https://docs.getnexor.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.getnexor.ai/docs/en/api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workflows (tasks)\",\"item\":\"https://docs.getnexor.ai/docs/en/api/workflows/list-workflows\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create an Agent\",\"item\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow#apireference\",\"headline\":\"Create an Agent\",\"name\":\"Create an Agent\",\"description\":\"This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.\",\"url\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getnexor.ai/docs/en/api/workflows/create-workflow#webpage\"},\"dateModified\":\"2026-11-12T19:23:26.000Z\",\"publisher\":{\"@id\":\"https://docs.getnexor.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getnexor.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nexor\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nexor\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/en/api/workflows/create-workflow.md","siteName":"Nexor","nav":{"global":null,"languages":[{"language":"en","groups":[{"group":"Start here","pages":[{"title":"Welcome to Nexor","sidebarTitle":"Welcome","href":"/docs/en/guides/getting-started"},{"title":"Agents and tasks","sidebarTitle":"Agents and tasks","href":"/docs/en/guides/getting-started/anatomy-of-an-agent"},{"title":"Changelog","href":"/docs/en/changelog"}]},{"group":"Quickstart","pages":[{"title":"Connect channels and bring in leads","sidebarTitle":"Connect your channels","href":"/docs/en/guides/getting-started/operate-and-connect-channels"},{"title":"Create your first agent","sidebarTitle":"Configure your agent","href":"/docs/en/guides/getting-started/overview"},{"title":"Bring in leads and connect your systems","sidebarTitle":"Bring in your leads","href":"/docs/en/guides/integrations/overview"}]},{"group":"API reference","pages":[{"title":"Introduction to the Nexor API","sidebarTitle":"Introduction","href":"/docs/en/api/introduction"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/docs/en/api/authentication"},{"title":"JavaScript SDK","sidebarTitle":"JavaScript SDK","href":"/docs/en/api/sdk"},{"group":"MCP Server","pages":[{"title":"MCP Server","sidebarTitle":"MCP Server","href":"/docs/en/api/mcp-server"},{"title":"MCP tool catalog","sidebarTitle":"Tool catalog","href":"/docs/en/api/mcp-server/tools"}]},{"group":"Leads","expanded":true,"pages":[{"title":"Create or Update Leads","sidebarTitle":"Create","openapi":"openapi.json POST /leads","href":"/docs/en/api/leads/create-lead"},{"title":"Force First Message","sidebarTitle":"First message","href":"/docs/en/api/leads/force-first-message"},{"title":"List Leads","sidebarTitle":"List","openapi":"openapi.json GET /leads","href":"/docs/en/api/leads/list-leads"},{"title":"List test conversations","sidebarTitle":"Test conversations","openapi":"openapi.json GET /test-conversations","href":"/docs/en/api/leads/list-test-conversations"},{"title":"Start a test conversation","sidebarTitle":"Start test conversation","openapi":"openapi.json POST /test-conversations","href":"/docs/en/api/leads/start-test-conversation"},{"title":"Send a message in a test conversation","sidebarTitle":"Send test message","openapi":"openapi.json POST /test-conversations/{conversation_id}/messages","href":"/docs/en/api/leads/send-test-message"},{"title":"Get Lead","sidebarTitle":"Get","openapi":"openapi.json GET /leads/{id}","href":"/docs/en/api/leads/get-lead"},{"title":"Update Lead","sidebarTitle":"Update","openapi":"openapi.json PUT /leads/{id}","href":"/docs/en/api/leads/update-lead"},{"title":"Patch Lead","sidebarTitle":"Patch","openapi":"openapi.json PATCH /leads/{id}","href":"/docs/en/api/leads/patch-lead"},{"title":"Set Lead Status","sidebarTitle":"Set Status","openapi":"openapi.json POST /leads/{id}/status","href":"/docs/en/api/leads/set-status"},{"title":"Patch Tags","sidebarTitle":"Patch tags","openapi":"openapi.json POST /leads/tags","href":"/docs/en/api/leads/patch-tags"},{"title":"Bulk Patch Metadata","sidebarTitle":"Bulk patch metadata","openapi":"openapi.json PATCH /leads/metadata","href":"/docs/en/api/leads/patch-metadata"},{"title":"Archive a Lead","sidebarTitle":"Archive","openapi":"openapi.json DELETE /leads/{id}","href":"/docs/en/api/leads/delete-leads-by-id"},{"title":"Assign Agent to Lead","sidebarTitle":"Assign Agent","openapi":"openapi.json POST /leads/{id}/assign-workflow","href":"/docs/en/api/leads/assign-workflow"},{"title":"Get Lead History","sidebarTitle":"Get History","openapi":"openapi.json GET /leads/{id}/history","href":"/docs/en/api/leads/get-lead-history"},{"title":"Get Lead Meetings","sidebarTitle":"Get Meetings","openapi":"openapi.json GET /leads/{id}/meetings","href":"/docs/en/api/leads/get-lead-meetings"},{"title":"Stop Automation","sidebarTitle":"Stop","openapi":"openapi.json POST /leads/{id}/automation/stop","href":"/docs/en/api/leads/stop-automation"},{"title":"Resume Automation","sidebarTitle":"Resume","openapi":"openapi.json POST /leads/{id}/automation/resume","href":"/docs/en/api/leads/resume-automation"}]},{"group":"Workflows (tasks)","expanded":true,"pages":[{"title":"List Agents","sidebarTitle":"List","openapi":"openapi.json GET /workflows","href":"/docs/en/api/workflows/list-workflows"},{"title":"Get an Agent","sidebarTitle":"Details","description":"This operation lets you get an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.","openapi":"openapi.json GET /workflows/{id}","href":"/docs/en/api/workflows/get-workflow"},{"title":"Create an Agent","sidebarTitle":"Create","openapi":"openapi.json POST /workflows","href":"/docs/en/api/workflows/create-workflow"},{"title":"Update an Agent","sidebarTitle":"Update","description":"This operation lets you update an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.","openapi":"openapi.json PATCH /workflows/{id}","href":"/docs/en/api/workflows/update-workflow"},{"title":"Archive an Agent","sidebarTitle":"Archive","openapi":"openapi.json DELETE /workflows/{id}","href":"/docs/en/api/workflows/delete-workflows-by-id"},{"title":"Update Agent Structure","sidebarTitle":"Structure","openapi":"openapi.json PATCH /workflows/{id}/structure","href":"/docs/en/api/workflows/update-workflow-structure"},{"title":"Test Workflow Tool","sidebarTitle":"Test a tool","openapi":"openapi.json POST /workflows/{id}/tools/{toolId}/test","href":"/docs/en/api/workflow-tools/test-workflow-tool"}]},{"group":"Messages","expanded":true,"pages":[{"title":"Send Message","sidebarTitle":"Send","openapi":"openapi.json POST /messages","href":"/docs/en/api/messages/send-message"},{"title":"List WhatsApp Templates","sidebarTitle":"List templates","openapi":"openapi.json GET /templates","href":"/docs/en/api/messages/list-templates"}]},{"group":"Meetings","expanded":false,"pages":[{"title":"Log a Meeting","sidebarTitle":"Log","openapi":"openapi.json POST /meetings","href":"/docs/en/api/meetings/create-meeting"},{"title":"List Meetings","sidebarTitle":"List","openapi":"openapi.json GET /meetings","href":"/docs/en/api/meetings/get-meetings"},{"title":"Get a Meeting","sidebarTitle":"Details","openapi":"openapi.json GET /meetings/{id}","href":"/docs/en/api/meetings/get-meetings-by-id"},{"title":"Cancel a Meeting","sidebarTitle":"Cancel","openapi":"openapi.json POST /meetings/{id}/cancel","href":"/docs/en/api/meetings/cancel-meeting"},{"title":"Reschedule a Meeting","sidebarTitle":"Reschedule","openapi":"openapi.json PATCH /meetings/{id}/reschedule","href":"/docs/en/api/meetings/patch-meetings-by-id-reschedule"},{"title":"Book a Meeting","sidebarTitle":"Book","openapi":"openapi.json POST /meetings/book","href":"/docs/en/api/meetings/post-meetings-book"},{"title":"Get Available Meeting Times","sidebarTitle":"Available times","openapi":"openapi.json GET /workflows/{id}/slots","href":"/docs/en/api/meetings/get-workflows-by-id-slots"},{"title":"Mark a Meeting as No-Show","sidebarTitle":"Mark as No-show","openapi":"openapi.json POST /meetings/{id}/no-show","href":"/docs/en/api/meetings/mark-no-show"},{"title":"Mark a Meeting as Completed","sidebarTitle":"Mark as Completed","openapi":"openapi.json POST /meetings/{id}/complete","href":"/docs/en/api/meetings/complete-meeting"}]},{"group":"Conversions","expanded":false,"pages":[{"title":"List Conversion Events","sidebarTitle":"List Events","openapi":"openapi.json GET /conversions","href":"/docs/en/api/conversions/list-conversions"},{"title":"Create Conversion Event","sidebarTitle":"Create Event","openapi":"openapi.json POST /conversions","href":"/docs/en/api/conversions/create-conversion"},{"title":"List Conversion Types","sidebarTitle":"List Types","openapi":"openapi.json GET /conversion-types","href":"/docs/en/api/conversions/list-conversion-types"}]},{"group":"Reports","expanded":false,"pages":[{"title":"Funnel Report","sidebarTitle":"Funnel","openapi":"openapi.json GET /reports/funnel","href":"/docs/en/api/reports/get-funnel-report"},{"title":"Lead Report","sidebarTitle":"Lead","openapi":"openapi.json GET /reports/lead/{lead_id}","href":"/docs/en/api/reports/get-lead-report"},{"title":"Get Meeting Statistics","sidebarTitle":"Meeting stats","openapi":"openapi.json GET /reports/meeting-stats","href":"/docs/en/api/reports/get-reports-meeting-stats"},{"title":"Team performance","sidebarTitle":"Team performance","openapi":"openapi.json GET /reports/team-performance","href":"/docs/en/api/reports/get-team-performance"},{"title":"Tool health","sidebarTitle":"Tool health","openapi":"openapi.json GET /tool-health","href":"/docs/en/api/reports/get-tool-health"},{"title":"Export a Leads Report","sidebarTitle":"Export leads","openapi":"openapi.json POST /reports/leads/export","href":"/docs/en/api/reports/post-reports-leads-export"}]},{"group":"Inbox","expanded":false,"pages":[{"title":"Inbox summary","sidebarTitle":"Summary","openapi":"openapi.json GET /inbox/summary","href":"/docs/en/api/inbox/get-inbox-summary"},{"title":"List escalations","sidebarTitle":"Escalations","openapi":"openapi.json GET /escalations","href":"/docs/en/api/inbox/list-escalations"}]},{"group":"Team availability","expanded":false,"pages":[{"title":"Get team availability","sidebarTitle":"Get","openapi":"openapi.json GET /team/availability","href":"/docs/en/api/team/get-team-availability"},{"title":"Change the idle time","sidebarTitle":"Change idle time","openapi":"openapi.json PATCH /team/availability/settings","href":"/docs/en/api/team/patch-team-availability-settings"},{"title":"Set a team member Away","sidebarTitle":"Set Away","openapi":"openapi.json PUT /team/availability/{user_id}","href":"/docs/en/api/team/put-team-availability-by-user-id"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Overview","href":"/docs/en/api/webhooks/overview"},{"title":"Receive leads by webhook","sidebarTitle":"Inbound leads","openapi":"openapi.json POST /leads/webhook","href":"/docs/en/api/webhooks/inbound-leads"},{"title":"Event: Status changed","href":"/docs/en/api/webhooks/status-changed"},{"title":"Event: Meeting events","href":"/docs/en/api/webhooks/meeting-events"},{"title":"Event: Outreach failed","href":"/docs/en/api/webhooks/outreach-failed"},{"title":"Events: Message sent, delivered and received","href":"/docs/en/api/webhooks/message-events"},{"title":"Verifying signatures","href":"/docs/en/api/webhooks/verifying-signatures"},{"title":"Retries and error handling","href":"/docs/en/api/webhooks/retries-and-errors"}]},{"group":"CRM Management","expanded":false,"pages":[{"title":"List native CRM booking choices","sidebarTitle":"Choices","openapi":"openapi.json GET /crm-management/booking/choices","href":"/docs/en/api/crm-management/list-choices"},{"title":"Read native CRM booking setup","sidebarTitle":"Read setup","openapi":"openapi.json GET /crm-management/booking","href":"/docs/en/api/crm-management/get-booking"},{"title":"Configure native CRM booking","sidebarTitle":"Configure or remove","openapi":"openapi.json POST /crm-management/booking","href":"/docs/en/api/crm-management/change-booking"},{"title":"Read GHL import evidence","sidebarTitle":"Import evidence","openapi":"openapi.json GET /crm-management/gohighlevel/import-status","href":"/docs/en/api/crm-management/get-ghl-import-status"}]},{"group":"CRM Chat","expanded":false,"pages":[{"title":"Configure CRM integrations through chat","sidebarTitle":"CRM configuration through chat","href":"/docs/en/guides/integrations/crm-chat-configuration"},{"title":"Get crm intake details","sidebarTitle":"Get crm intake details","openapi":"openapi.json GET /crm-account/intake-details","href":"/docs/en/api/crm-chat/get-crm-intake-details"},{"title":"Rotate kommo webhook token","sidebarTitle":"Rotate kommo webhook token","openapi":"openapi.json POST /crm-account/kommo/rotate-token","href":"/docs/en/api/crm-chat/rotate-kommo-webhook-token"},{"title":"Get crm import job","sidebarTitle":"Get crm import job","openapi":"openapi.json GET /crm-account/import-job","href":"/docs/en/api/crm-chat/get-crm-import-job"},{"title":"Get hubspot sync preview","sidebarTitle":"Get hubspot sync preview","openapi":"openapi.json GET /crm-account/hubspot/sync-preview","href":"/docs/en/api/crm-chat/get-hubspot-sync-preview"},{"title":"Run hubspot sync","sidebarTitle":"Run hubspot sync","openapi":"openapi.json POST /crm-account/hubspot/sync","href":"/docs/en/api/crm-chat/run-hubspot-sync"},{"title":"List odoo sync conflicts","sidebarTitle":"List odoo sync conflicts","openapi":"openapi.json GET /crm-account/odoo/conflicts","href":"/docs/en/api/crm-chat/list-odoo-sync-conflicts"},{"title":"Resolve odoo sync conflict","sidebarTitle":"Resolve odoo sync conflict","openapi":"openapi.json POST /crm-account/odoo/conflicts/resolve","href":"/docs/en/api/crm-chat/resolve-odoo-sync-conflict"},{"title":"Change odoo account outputs","sidebarTitle":"Change odoo account outputs","openapi":"openapi.json POST /crm-account/odoo/outputs","href":"/docs/en/api/crm-chat/change-odoo-account-outputs"},{"title":"List crm account connections","sidebarTitle":"List crm account connections","openapi":"openapi.json GET /crm-account/connections","href":"/docs/en/api/crm-chat/list-crm-account-connections"},{"title":"Change odoo account inputs","sidebarTitle":"Change odoo account inputs","openapi":"openapi.json POST /crm-account/odoo/inputs","href":"/docs/en/api/crm-chat/change-odoo-account-inputs"},{"title":"Get crm account configuration","sidebarTitle":"Get crm account configuration","openapi":"openapi.json GET /crm-account/configuration","href":"/docs/en/api/crm-chat/get-crm-account-configuration"},{"title":"Change zoho account defaults","sidebarTitle":"Change zoho account defaults","openapi":"openapi.json POST /crm-account/zoho/defaults","href":"/docs/en/api/crm-chat/change-zoho-account-defaults"},{"title":"Change hubspot account controls","sidebarTitle":"Change hubspot account controls","openapi":"openapi.json POST /crm-account/hubspot/controls","href":"/docs/en/api/crm-chat/change-hubspot-account-controls"},{"title":"Reassign crm intake","sidebarTitle":"Reassign crm intake","openapi":"openapi.json POST /crm-account/reassign","href":"/docs/en/api/crm-chat/reassign-crm-intake"},{"title":"Run crm account import","sidebarTitle":"Run crm account import","openapi":"openapi.json POST /crm-account/import","href":"/docs/en/api/crm-chat/run-crm-account-import"},{"title":"Get agent crm diagnostics","sidebarTitle":"Get agent crm diagnostics","openapi":"openapi.json GET /crm-management/diagnostics","href":"/docs/en/api/crm-chat/get-agent-crm-diagnostics"},{"title":"List agent hubspot catalog","sidebarTitle":"List agent hubspot catalog","openapi":"openapi.json GET /crm-management/hubspot/catalog","href":"/docs/en/api/crm-chat/list-agent-hubspot-catalog"},{"title":"Count agent kommo source","sidebarTitle":"Count agent kommo source","openapi":"openapi.json GET /crm-management/kommo/source-count","href":"/docs/en/api/crm-chat/count-agent-kommo-source"},{"title":"Get agent odoo inputs","sidebarTitle":"Get agent odoo inputs","openapi":"openapi.json GET /crm-management/odoo/inputs","href":"/docs/en/api/crm-chat/get-agent-odoo-inputs"},{"title":"Preview agent odoo inputs","sidebarTitle":"Preview agent odoo inputs","openapi":"openapi.json POST /crm-management/odoo/inputs/preview","href":"/docs/en/api/crm-chat/preview-agent-odoo-inputs"},{"title":"Change agent odoo inputs","sidebarTitle":"Change agent odoo inputs","openapi":"openapi.json POST /crm-management/odoo/inputs/save","href":"/docs/en/api/crm-chat/change-agent-odoo-inputs"},{"title":"Create CRM connection","sidebarTitle":"Create connection","openapi":"openapi.json POST /crm-connections/connect","href":"/docs/en/api/integrations/create-crm-connection"},{"title":"Get CRM connection","sidebarTitle":"Connection status","openapi":"openapi.json GET /crm-connections/{provider}","href":"/docs/en/api/integrations/get-crm-connection"},{"title":"Disconnect CRM","sidebarTitle":"Disconnect","openapi":"openapi.json POST /crm-connections/{provider}/disconnect","href":"/docs/en/api/integrations/disconnect-crm"}]},{"group":"Agents","expanded":false,"pages":[{"title":"Set phone-menu navigation","sidebarTitle":"Phone-menu navigation","openapi":"openapi.json PUT /master-workflows/{id}/ivr-navigation","href":"/docs/en/api/master-workflows/set-ivr-navigation"}]},{"group":"Inbound router","expanded":false,"pages":[{"title":"Get inbound router","sidebarTitle":"Get settings","openapi":"openapi.json GET /master-workflows/{id}/router","href":"/docs/en/api/inbound-router/get-inbound-router"},{"title":"Update inbound router","sidebarTitle":"Update settings","openapi":"openapi.json PUT /master-workflows/{id}/router","href":"/docs/en/api/inbound-router/update-inbound-router"},{"title":"Get incoming calls","sidebarTitle":"Get incoming calls","openapi":"openapi.json GET /master-workflows/{id}/inbound-calls","href":"/docs/en/api/inbound-router/get-inbound-calls"},{"title":"Update incoming calls","sidebarTitle":"Update incoming calls","openapi":"openapi.json PUT /master-workflows/{id}/inbound-calls","href":"/docs/en/api/inbound-router/update-inbound-calls"},{"title":"Get topic transfer rules","sidebarTitle":"Get topic transfer rules","openapi":"openapi.json GET /master-workflows/{id}/transfer-rules","href":"/docs/en/api/inbound-router/get-transfer-rules"},{"title":"Update topic transfer rules","sidebarTitle":"Update topic transfer rules","openapi":"openapi.json PUT /master-workflows/{id}/transfer-rules","href":"/docs/en/api/inbound-router/update-transfer-rules"},{"title":"List routing rules","sidebarTitle":"List rules","openapi":"openapi.json GET /master-workflows/{id}/router/rules","href":"/docs/en/api/inbound-router/list-routing-rules"},{"title":"Replace routing rules","sidebarTitle":"Replace rules","openapi":"openapi.json PUT /master-workflows/{id}/router/rules","href":"/docs/en/api/inbound-router/replace-routing-rules"},{"title":"Update shared identity","sidebarTitle":"Update identity","openapi":"openapi.json PUT /master-workflows/{id}/router/identity","href":"/docs/en/api/inbound-router/update-agent-identity"},{"title":"Test a message","sidebarTitle":"Test a message","openapi":"openapi.json POST /master-workflows/{id}/router/test","href":"/docs/en/api/inbound-router/test-inbound-router"},{"title":"List routing decisions","sidebarTitle":"List decisions","openapi":"openapi.json GET /master-workflows/{id}/router/decisions","href":"/docs/en/api/inbound-router/list-routing-decisions"},{"title":"Get routing stats","sidebarTitle":"Get stats","openapi":"openapi.json GET /master-workflows/{id}/router/stats","href":"/docs/en/api/inbound-router/get-routing-stats"},{"title":"List entry points","sidebarTitle":"List entry points","openapi":"openapi.json GET /entry-points","href":"/docs/en/api/inbound-router/list-entry-points"},{"title":"Set entry point destination","sidebarTitle":"Set destination","openapi":"openapi.json PUT /entry-points/destination","href":"/docs/en/api/inbound-router/set-entry-point-destination"}]},{"group":"Agent files","expanded":false,"pages":[{"title":"List agent files","sidebarTitle":"List","openapi":"openapi.json GET /file-library/files","href":"/docs/en/api/agent-files/list-agent-files"},{"title":"Get agent file","sidebarTitle":"Get","openapi":"openapi.json GET /file-library/files/{id}","href":"/docs/en/api/agent-files/get-agent-file"},{"title":"Update agent file","sidebarTitle":"Update","openapi":"openapi.json PATCH /file-library/files/{id}","href":"/docs/en/api/agent-files/update-agent-file"},{"title":"Set agent file availability","sidebarTitle":"Set availability","openapi":"openapi.json PUT /file-library/files/{id}/availability","href":"/docs/en/api/agent-files/set-agent-file-availability"},{"title":"Delete agent file","sidebarTitle":"Delete","openapi":"openapi.json DELETE /file-library/files/{id}","href":"/docs/en/api/agent-files/delete-agent-file"}]},{"group":"Sub-accounts","expanded":false,"pages":[{"title":"List sub-accounts","sidebarTitle":"List","openapi":"openapi.json GET /sub-accounts","href":"/docs/en/api/sub-accounts/list-sub-accounts"},{"title":"Create sub-account","sidebarTitle":"Create","openapi":"openapi.json POST /sub-accounts","href":"/docs/en/api/sub-accounts/create-sub-account"},{"title":"Resend sub-account invitation","sidebarTitle":"Resend invitation","openapi":"openapi.json POST /sub-accounts/{sub_account_id}/invitations/resend","href":"/docs/en/api/sub-accounts/resend-sub-account-invitation"},{"title":"Copy an agent to a sub-account","sidebarTitle":"Copy an agent","openapi":"openapi.json POST /sub-accounts/{sub_account_id}/agents/duplicate","href":"/docs/en/api/sub-accounts/copy-agent-to-sub-account"},{"title":"Pause sub-account","sidebarTitle":"Pause","openapi":"openapi.json POST /sub-accounts/{sub_account_id}/pause","href":"/docs/en/api/sub-accounts/pause-sub-account"},{"title":"Deactivate sub-account","sidebarTitle":"Deactivate","openapi":"openapi.json POST /sub-accounts/{sub_account_id}/deactivate","href":"/docs/en/api/sub-accounts/deactivate-sub-account"},{"title":"Reactivate sub-account","sidebarTitle":"Reactivate","openapi":"openapi.json POST /sub-accounts/{sub_account_id}/reactivate","href":"/docs/en/api/sub-accounts/reactivate-sub-account"}]},{"group":"Scheduled Functions","expanded":false,"pages":[{"title":"List Scheduled Functions","sidebarTitle":"List","openapi":"openapi.json GET /scheduled-functions","href":"/docs/en/api/scheduled-functions/list-scheduled-functions"},{"title":"Get a Scheduled Function","sidebarTitle":"Details","openapi":"openapi.json GET /scheduled-functions/{id}","href":"/docs/en/api/scheduled-functions/get-scheduled-function"},{"title":"Create a Scheduled Function","sidebarTitle":"Create","openapi":"openapi.json POST /scheduled-functions","href":"/docs/en/api/scheduled-functions/create-scheduled-function"},{"title":"Update a Scheduled Function","sidebarTitle":"Update","openapi":"openapi.json PATCH /scheduled-functions/{id}","href":"/docs/en/api/scheduled-functions/update-scheduled-function"},{"title":"Save a Scheduled Function draft","sidebarTitle":"Save draft","openapi":"openapi.json PATCH /scheduled-functions/{id}/draft","href":"/docs/en/api/scheduled-functions/save-draft"},{"title":"Discard a Scheduled Function draft","sidebarTitle":"Discard draft","openapi":"openapi.json DELETE /scheduled-functions/{id}/draft","href":"/docs/en/api/scheduled-functions/discard-draft"},{"title":"Test a Scheduled Function","sidebarTitle":"Test","openapi":"openapi.json POST /scheduled-functions/{id}/test","href":"/docs/en/api/scheduled-functions/test-scheduled-function"},{"title":"Publish a Scheduled Function draft","sidebarTitle":"Publish","openapi":"openapi.json POST /scheduled-functions/{id}/publish","href":"/docs/en/api/scheduled-functions/publish-scheduled-function"},{"title":"List Scheduled Function versions","sidebarTitle":"Versions","openapi":"openapi.json GET /scheduled-functions/{id}/versions","href":"/docs/en/api/scheduled-functions/list-versions"},{"title":"Get a Scheduled Function version","sidebarTitle":"Version details","openapi":"openapi.json GET /scheduled-functions/{id}/versions/{versionNumber}","href":"/docs/en/api/scheduled-functions/get-version"},{"title":"Restore a Scheduled Function version","sidebarTitle":"Restore version","openapi":"openapi.json POST /scheduled-functions/{id}/versions/{versionNumber}/restore","href":"/docs/en/api/scheduled-functions/restore-version"},{"title":"Run a Scheduled Function Now","sidebarTitle":"Run now","openapi":"openapi.json POST /scheduled-functions/{id}/run","href":"/docs/en/api/scheduled-functions/run-scheduled-function"},{"title":"Preview a Scheduled Function Schedule","sidebarTitle":"Preview schedule","openapi":"openapi.json POST /scheduled-functions/preview-schedule","href":"/docs/en/api/scheduled-functions/preview-schedule"},{"title":"Preview a Scheduled Function Cohort","sidebarTitle":"Preview cohort","openapi":"openapi.json POST /scheduled-functions/preview-cohort","href":"/docs/en/api/scheduled-functions/preview-cohort"},{"title":"View the Scheduled Functions Reference","sidebarTitle":"Reference","openapi":"openapi.json GET /scheduled-functions/reference","href":"/docs/en/api/scheduled-functions/reference"},{"title":"List Scheduled Function Runs","sidebarTitle":"Run history","openapi":"openapi.json GET /scheduled-functions/runs","href":"/docs/en/api/scheduled-functions/list-runs"},{"title":"Get a Scheduled Function Run","sidebarTitle":"Run details","openapi":"openapi.json GET /scheduled-functions/runs/{runId}","href":"/docs/en/api/scheduled-functions/get-run"},{"title":"Clear Scheduled Function Run History","sidebarTitle":"Clear run history","openapi":"openapi.json DELETE /scheduled-functions/runs","href":"/docs/en/api/scheduled-functions/clear-runs"}]},{"group":"Cloud Functions","expanded":false,"pages":[{"title":"List Cloud Functions","sidebarTitle":"List","openapi":"openapi.json GET /cloud-functions","href":"/docs/en/api/cloud-functions/get-cloud-functions"},{"title":"Get a Cloud Function","sidebarTitle":"Details","openapi":"openapi.json GET /cloud-functions/{id}","href":"/docs/en/api/cloud-functions/get-cloud-functions-by-id"},{"title":"Create a Cloud Function","sidebarTitle":"Create","openapi":"openapi.json POST /cloud-functions","href":"/docs/en/api/cloud-functions/post-cloud-functions"},{"title":"Update a Cloud Function","sidebarTitle":"Update","openapi":"openapi.json PATCH /cloud-functions/{id}","href":"/docs/en/api/cloud-functions/patch-cloud-functions-by-id"},{"title":"Delete a Cloud Function","sidebarTitle":"Delete","openapi":"openapi.json DELETE /cloud-functions/{id}","href":"/docs/en/api/cloud-functions/delete-cloud-functions-by-id"},{"title":"Save a Cloud Function draft","sidebarTitle":"Save draft","openapi":"openapi.json PATCH /cloud-functions/{id}/draft","href":"/docs/en/api/cloud-functions/patch-cloud-functions-by-id-draft"},{"title":"Discard a Cloud Function draft","sidebarTitle":"Discard draft","openapi":"openapi.json DELETE /cloud-functions/{id}/draft","href":"/docs/en/api/cloud-functions/delete-cloud-functions-by-id-draft"},{"title":"Test a Cloud Function","sidebarTitle":"Test","openapi":"openapi.json POST /cloud-functions/{id}/test","href":"/docs/en/api/cloud-functions/post-cloud-functions-by-id-test"},{"title":"Publish a Cloud Function draft","sidebarTitle":"Publish","openapi":"openapi.json POST /cloud-functions/{id}/publish","href":"/docs/en/api/cloud-functions/post-cloud-functions-by-id-publish"},{"title":"List Cloud Function versions","sidebarTitle":"Versions","openapi":"openapi.json GET /cloud-functions/{id}/versions","href":"/docs/en/api/cloud-functions/get-cloud-functions-by-id-versions"},{"title":"Get a Cloud Function version","sidebarTitle":"Version details","openapi":"openapi.json GET /cloud-functions/{id}/versions/{versionNumber}","href":"/docs/en/api/cloud-functions/get-cloud-functions-by-id-versions-by-version-number"},{"title":"Restore a Cloud Function version","sidebarTitle":"Restore version","openapi":"openapi.json POST /cloud-functions/{id}/versions/{versionNumber}/restore","href":"/docs/en/api/cloud-functions/post-cloud-functions-by-id-versions-by-version-number-restore"},{"title":"Run a Cloud Function","sidebarTitle":"Run now","openapi":"openapi.json POST /cloud-functions/{id}/run","href":"/docs/en/api/cloud-functions/post-cloud-functions-by-id-run"},{"title":"List Cloud Function Runs","sidebarTitle":"Run history","openapi":"openapi.json GET /cloud-functions/runs","href":"/docs/en/api/cloud-functions/get-cloud-functions-runs"},{"title":"Get a Cloud Function Run","sidebarTitle":"Run details","openapi":"openapi.json GET /cloud-functions/runs/{runId}","href":"/docs/en/api/cloud-functions/get-cloud-functions-runs-by-run-id"},{"title":"Clear Cloud Function Run History","sidebarTitle":"Clear run history","openapi":"openapi.json DELETE /cloud-functions/runs","href":"/docs/en/api/cloud-functions/delete-cloud-functions-runs"},{"title":"List Function Environment Variables","sidebarTitle":"Environment variables","openapi":"openapi.json GET /cloud-functions/environment-variables","href":"/docs/en/api/cloud-functions/get-cloud-functions-environment-variables"},{"title":"Set a Function Environment Variable","sidebarTitle":"Set variable","openapi":"openapi.json PUT /cloud-functions/environment-variables/{key}","href":"/docs/en/api/cloud-functions/put-cloud-functions-environment-variables-by-key"},{"title":"Delete a Function Environment Variable","sidebarTitle":"Delete variable","openapi":"openapi.json DELETE /cloud-functions/environment-variables/{key}","href":"/docs/en/api/cloud-functions/delete-cloud-functions-environment-variables-by-key"}]},{"title":"Read discard reasons","sidebarTitle":"Read discard reasons","openapi":"openapi.json GET /workflows/{id}/discard-reasons","href":"/docs/en/api/workflows/get-discard-reasons"},{"title":"Edit discard definitions","sidebarTitle":"Edit discard definitions","openapi":"openapi.json PATCH /workflows/{id}/discard-reasons","href":"/docs/en/api/workflows/set-discard-reason-definitions"},{"title":"Manage discard reasons","sidebarTitle":"Manage discard reasons","openapi":"openapi.json POST /workflows/discard-reasons/changes","href":"/docs/en/api/workflows/change-discard-reasons"}]},{"group":"Build and launch","pages":[{"title":"Build and change your agents with Nexor AI","sidebarTitle":"Nexor AI","href":"/docs/en/guides/getting-started/build-with-nexorgpt"},{"title":"Test your agent","sidebarTitle":"Test your agent","href":"/docs/en/guides/getting-started/test-in-playground"},{"title":"Tasks that work together","sidebarTitle":"Tasks that work together","href":"/docs/en/guides/getting-started/connected-agents"},{"title":"Go-live checklist","sidebarTitle":"Go-live checklist","href":"/docs/en/guides/getting-started/launch-checklist"},{"title":"Plan your agent","sidebarTitle":"Plan your agent","href":"/docs/en/guides/getting-started/define-your-use-case"},{"title":"For developers","sidebarTitle":"For developers","href":"/docs/en/guides/getting-started/for-developers"}]},{"group":"WhatsApp","pages":[{"title":"Connect WhatsApp","sidebarTitle":"Connect WhatsApp","href":"/docs/en/guides/connecting-whatsapp"},{"title":"WhatsApp message templates","sidebarTitle":"Message templates","href":"/docs/en/guides/whatsapp/message-templates"},{"title":"Consent and opt-out on WhatsApp","sidebarTitle":"Consent and opt-out","href":"/docs/en/guides/whatsapp/consent-and-opt-out"},{"title":"Message delivery and account quality","sidebarTitle":"Delivery and quality","href":"/docs/en/guides/whatsapp/delivery-and-quality"},{"title":"Verify your business with Meta","sidebarTitle":"Business verification","href":"/docs/en/guides/whatsapp/business-verification"},{"title":"WhatsApp connection troubleshooting","sidebarTitle":"Troubleshooting","href":"/docs/en/guides/whatsapp/troubleshooting"},{"title":"WhatsApp error code reference","sidebarTitle":"Error codes","href":"/docs/en/guides/whatsapp/error-codes"},{"title":"WhatsApp pricing","sidebarTitle":"Pricing","href":"/docs/en/guides/whatsapp/pricing"}]},{"group":"Channels","pages":[{"title":"Set up voice calls","sidebarTitle":"Voice","href":"/docs/en/guides/channels/voice"},{"title":"Email","sidebarTitle":"Email","href":"/docs/en/guides/channels/email"},{"title":"Set up SMS and US 10DLC","sidebarTitle":"SMS and 10DLC","href":"/docs/en/guides/channels/sms-and-10dlc"},{"title":"Web Chat","sidebarTitle":"Web Chat","href":"/docs/en/guides/channels/web-chat"},{"title":"Connect Instagram","sidebarTitle":"Instagram","href":"/docs/en/guides/channels/instagram"},{"title":"Connect Messenger","sidebarTitle":"Messenger","href":"/docs/en/guides/channels/messenger"}]},{"group":"Agents","pages":[{"title":"Pipeline and Agent operations","sidebarTitle":"Pipeline","href":"/docs/en/guides/agents/pipeline"},{"title":"Agent settings","sidebarTitle":"Settings","href":"/docs/en/guides/agents/settings"},{"title":"Agent map: what happens when a lead comes in","sidebarTitle":"Agent map","href":"/docs/en/guides/agents/agent-map"},{"title":"Drafts and versions: test changes before your leads see them","sidebarTitle":"Drafts and versions","href":"/docs/en/guides/agents/drafts-and-versions"},{"title":"AI Receptionist: route new leads and transfer calls","sidebarTitle":"AI Receptionist","href":"/docs/en/guides/agents/router"},{"title":"Logical check","sidebarTitle":"Logical check","href":"/docs/en/guides/agents/logical-check"},{"title":"Prompt best practices","sidebarTitle":"Best practices","href":"/docs/en/guides/agents/prompt-best-practices"},{"title":"Knowledge base, files and product catalogs","sidebarTitle":"Knowledge base","href":"/docs/en/guides/agents/knowledge-base"},{"title":"Connected sources: Instagram and Google Drive","sidebarTitle":"Connected sources","href":"/docs/en/guides/agents/connected-sources"},{"title":"Track conversions","sidebarTitle":"Conversions","href":"/docs/en/guides/agents/conversions"},{"group":"Leads","pages":[{"title":"Manage leads","sidebarTitle":"Manage","href":"/docs/en/guides/agents/leads/manage-leads"},{"title":"Lead details and conversations","sidebarTitle":"Details and chat","href":"/docs/en/guides/agents/leads/conversations"},{"title":"Organize leads with tags","sidebarTitle":"Tags","href":"/docs/en/guides/agents/leads/tags"},{"title":"Add a lead manually","sidebarTitle":"Add manually","href":"/docs/en/guides/agents/leads/manual-upload"},{"title":"Upload leads from CSV or Excel","sidebarTitle":"Upload a file","href":"/docs/en/guides/agents/leads/csv-upload"},{"title":"Connect HubSpot","sidebarTitle":"HubSpot","href":"/docs/en/guides/agents/leads/hubspot"},{"title":"Connect Kommo","href":"/docs/en/guides/agents/leads/kommo"},{"title":"Connect API","href":"/docs/en/guides/agents/leads/api"},{"title":"Test leads","sidebarTitle":"Test","href":"/docs/en/guides/agents/leads/test-leads"}]}]},{"group":"Meetings","pages":[{"title":"Manage meetings","sidebarTitle":"Overview","href":"/docs/en/guides/meetings/overview"},{"title":"Calendars and availability","sidebarTitle":"Calendars and availability","href":"/docs/en/guides/meetings/calendars-and-availability"},{"title":"Configure meeting types and hosts","sidebarTitle":"Meeting types \u0026 hosts","href":"/docs/en/guides/meetings/meeting-types-and-hosts"},{"title":"Configure reminders and alerts","sidebarTitle":"Reminders \u0026 alerts","href":"/docs/en/guides/meetings/reminders-and-alerts"},{"title":"CRM booking through chat","sidebarTitle":"CRM booking through chat","href":"/docs/en/guides/meetings/crm-booking-chat"}]},{"group":"Integrations","pages":[{"title":"Google Calendar","sidebarTitle":"Google Calendar","href":"/docs/en/guides/integrations/google-calendar"},{"title":"Outlook Calendar","sidebarTitle":"Outlook Calendar","href":"/docs/en/guides/integrations/outlook-calendar"},{"title":"Zoom","sidebarTitle":"Zoom","href":"/docs/en/guides/integrations/zoom"},{"title":"Connect Calendly","sidebarTitle":"Calendly","href":"/docs/en/guides/integrations/calendly"},{"title":"Connect Cal.com","sidebarTitle":"Cal.com","href":"/docs/en/guides/integrations/calcom"},{"title":"Custom connection","sidebarTitle":"Custom connection","href":"/docs/en/guides/integrations/custom-connection"},{"title":"Connect GoHighLevel","sidebarTitle":"GoHighLevel","href":"/docs/en/guides/integrations/gohighlevel"},{"title":"Connect Zoho CRM","sidebarTitle":"Zoho CRM","href":"/docs/en/guides/integrations/zoho"},{"title":"Connect Salesforce","sidebarTitle":"Salesforce","href":"/docs/en/guides/integrations/salesforce"},{"title":"Connect Odoo","sidebarTitle":"Odoo","href":"/docs/en/guides/integrations/odoo"},{"title":"Connect Google Sheets","sidebarTitle":"Google Sheets","href":"/docs/en/guides/integrations/google-sheets"},{"title":"Connect Slack","sidebarTitle":"Slack","href":"/docs/en/guides/integrations/slack"},{"title":"Connect apps and MCP servers","sidebarTitle":"Apps and MCP servers","href":"/docs/en/guides/integrations/mcp-apps"}]},{"group":"Account","pages":[{"title":"Personal profile and preferences","sidebarTitle":"Profile","href":"/docs/en/guides/account/profile"},{"title":"Members, roles, and access","sidebarTitle":"Members and roles","href":"/docs/en/guides/account/members-and-roles"},{"title":"Notification settings","sidebarTitle":"Notifications","href":"/docs/en/guides/account/notifications"},{"title":"Billing, lead quota, and invoices","sidebarTitle":"Billing","href":"/docs/en/guides/account/billing"},{"title":"Reactivate a canceled plan","sidebarTitle":"Reactivate plan","href":"/docs/en/guides/account/reactivate-plan"},{"title":"Sub-accounts","sidebarTitle":"Sub-accounts","href":"/docs/en/guides/account/sub-accounts"}]},{"group":"Inbox","pages":[{"title":"Inbox overview","sidebarTitle":"Overview","href":"/docs/en/guides/inbox/overview"},{"title":"Handle escalations in Inbox","sidebarTitle":"Escalations","href":"/docs/en/guides/inbox/escalations"}]},{"group":"Insights","pages":[{"title":"Insights dashboards","sidebarTitle":"Dashboards","href":"/docs/en/guides/insights/dashboards"}]},{"group":"Developer tools","pages":[{"title":"Advanced automation","sidebarTitle":"Overview","href":"/docs/en/guides/advanced/overview"},{"title":"Cloud Functions","sidebarTitle":"Cloud Functions","href":"/docs/en/guides/advanced/cloud-functions"},{"title":"Scheduled Functions","sidebarTitle":"Scheduled Functions","href":"/docs/en/guides/advanced/scheduled-functions"}]},{"group":"Support reference","pages":[{"title":"Glossary: agent, task, group and old names","sidebarTitle":"Glossary","href":"/docs/en/support/glossary"},{"title":"Settings scope: account, agent and task","sidebarTitle":"Settings scope","href":"/docs/en/support/settings-scope"},{"title":"Find a setting: v2 workspace vs classic v1","sidebarTitle":"Find a setting","href":"/docs/en/support/where-is-each-setting"},{"title":"Contact hours, cadence and follow-up rules","sidebarTitle":"Contact hours and cadence","href":"/docs/en/support/contact-hours-and-cadence"},{"title":"Assign leads only to Active team members (Active / Away)","sidebarTitle":"Only Active team members","href":"/docs/en/support/assign-only-active-agents"},{"title":"Troubleshoot CRM sync and lead intake","sidebarTitle":"CRM sync and lead intake","href":"/docs/en/support/crm-sync-and-lead-intake"},{"title":"WhatsApp Coexistence: messages not showing in the WhatsApp Business app","sidebarTitle":"WhatsApp Coexistence sync","href":"/docs/en/support/whatsapp-coexistence-sync"},{"title":"Product news in the app (What's new window)","sidebarTitle":"Product news in the app","href":"/docs/en/support/product-news-in-the-app"},{"title":"Support tickets from Nexor AI (open a ticket, check my tickets)","sidebarTitle":"Support tickets from Nexor AI","href":"/docs/en/support/support-tickets-from-nexor-ai"},{"title":"Contact Nexor support (support email, delete my account)","sidebarTitle":"Contact us","href":"/docs/en/support/contact-support"},{"title":"Classic Overview dashboard (v1): metrics and warnings","sidebarTitle":"Classic dashboard (v1)","href":"/docs/en/guides/getting-started/dashboard"},{"group":"US compliance","pages":[{"title":"US outreach regulations: consent, AI calls, texts and calling hours","sidebarTitle":"US outreach rules","href":"/docs/en/guides/compliance/us-outreach-overview"},{"title":"US state-by-state regulations for calls and texts","sidebarTitle":"State-by-state rules","href":"/docs/en/guides/compliance/us-state-rules"},{"title":"AI disclosure and call recording rules for US agents","sidebarTitle":"AI disclosure and recording","href":"/docs/en/guides/compliance/ai-disclosure-and-recording"}]}]}]},{"language":"es","pages":[{"title":"es","href":"/docs/es/api/workflows/create-workflow"}]}]},"basePath":"","title":"Create an Agent - Nexor","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}