Skip to content
MoreVoiceDevelopers

Create a flow

POST
/flows
import MoreVoice from "@morevoice/sdk";


const mv = new MoreVoice(); // MOREVOICE_API_KEY from the environment


const flow = await mv.flows.create({
  kind: "voice",
  language: "en",
  name: "Reception",
});
console.log(flow);

Creates a flow with an empty draft, a template’s, or the graph you send. It runs on calls once published (POST /v1/flows/{id}/publish).

Try it in the API playground with a test-mode key.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
MoreVoice-Version
string
/^\d{4}-\d{2}-\d{2}$/

The API version to use for this request. Defaults to the version the API key is pinned to.

Example
2026-11-01
Idempotency-Key
string
>= 1 characters <= 255 characters

A unique key (for example a UUID) that makes this request safe to retry: for 24 hours, a retry with the same key and parameters returns the first response instead of acting twice.

Example
5f0c1e8a-7b2d-4c3e-9f1a-2b6d8e4c0a17

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

A new flow. It starts as a draft: publish it before calls can run it.

object
assistant_id
Any of:

A assistant ID (asst_…).

string
<= 200 characters /^asst_[0-9A-Za-z]+$/
description
string
<= 2000 characters
graph

The draft graph (default: a template’s, or an empty flow).

object
kind

Must be the flow’s kind (default: the flow’s).

string
Allowed values: voice agent_script ivr
nodes
required
Array<object>
<= 2000 items

A flow node to write (v1 node schema). Settings you leave out keep their stored values, or the type’s defaults for a new node.

object
ai_agent

Type ai_agent: A free conversation step with a goal: the AI talks until a transition matches.

object
allowed_tools

The assistant’s tools usable in this step (by name).

Array<string>
<= 50 items
collect

Variables the AI gathers in this step.

Array<object>
<= 50 items
object
required
required
boolean
var
required
string
<= 120 characters
goal
string
<= 4000 characters
instructions
string
<= 20000 characters
kb

Answer from these knowledge-base documents.

object
document_ids
required
Array<string>
<= 200 items
min_score
number
<= 1
max_turns
integer
>= 1 <= 100
opening
string
<= 4000 characters
api

Type api: Call an HTTP API during the call; map the response to variables.

object
auth

How the request authenticates. Reference credentials as {{secrets.NAME}} rather than in clear.

object
header

Api_key / hmac (required): the header name.

string
<= 200 characters
password

Basic (required).

string
<= 4000 characters
secret

Hmac (required): the signing secret.

string
<= 4000 characters
token

Bearer (required).

string
<= 4000 characters
type
required
string
Allowed values: none bearer basic api_key hmac
username

Basic (required).

string
<= 500 characters
value

Api_key (required).

string
<= 4000 characters
body

The body template ({{templates}} JSON-escaped when body_type is json).

string
<= 100000 characters
body_type
string
Allowed values: json form none
headers
Array<object>
<= 100 items
object
key
required
string
<= 200 characters
value
required
string
<= 4000 characters
method
string
Allowed values: GET POST PUT PATCH DELETE
query
Array<object>
<= 100 items
object
key
required
string
<= 200 characters
value
required
string
<= 4000 characters
response_map

Response fields → variables.

Array<object>
<= 100 items
object
path
required

E.g. data.items[0].name

string
<= 500 characters
var
required
string
<= 120 characters
retries
integer
<= 5
success_when

When the response counts as a success (default: any 2xx).

object
mode
required
string
Allowed values: all any
rules
required
Array<object>
<= 50 items

A rule on a variable.

object
op
required
string
Allowed values: eq neq gt gte lt lte contains not_contains matches exists empty in not_in
value
Any of:
string
<= 2000 characters
var
required

A variable key, e.g. budget, contact.city, api.status.

string
<= 120 characters
timeout_ms
integer
>= 100 <= 60000
url

The URL ({{templates}} allowed).

string
<= 4000 characters
wait_text

Said while waiting.

string
<= 1000 characters
decision

Type decision: Branch by rules on variables (no AI).

object
note
string
<= 2000 characters
disabled
boolean
dtmf_menu

Type dtmf_menu: A keypad menu.

object
also_speech

Callers may say the option instead of pressing it.

boolean
audio_id

A audio asset ID (aud_…).

string
<= 200 characters /^aud_[0-9A-Za-z]+$/
invalid_prompt
string
<= 2000 characters
no_input_prompt
string
<= 2000 characters
options
Array<object>
<= 40 items
object
digit
required
string
<= 8 characters
keywords
Array<string>
<= 50 items
label
required

Also the spoken choice.

string
<= 200 characters
prompt
string
<= 4000 characters
retries
integer
<= 10
timeout_seconds
number
>= 1 <= 120
end

Type end: End the call.

object
disposition
string
<= 120 characters
message
string
<= 4000 characters
notes
string
<= 2000 characters
reason
string
<= 200 characters
global
Any of:

Makes the node reachable from anywhere in the call when its condition matches.

object
after
required

Return: back to where the caller was; stay: continue here; goto: follow this node’s transitions.

string
Allowed values: return stay goto
condition
required

Intent, keyword or dtmf.

object
after_seconds

No_response (required): seconds of silence.

number
>= 1 <= 600
description

Intent (required): what the caller means.

string
<= 2000 characters
digits

Dtmf (required): keypad digits — 1, *, # or a range 1-3.

string
<= 20 characters
examples

Intent: example phrasings.

Array<string>
<= 50 items
kind
required

Intent: the AI decides what the caller means · keyword · variable rules (no AI) · dtmf keys · always (right after the node) · no_response · outcome of an action · else (the fallback, last).

string
Allowed values: intent keyword variable dtmf always no_response outcome else
match

Keyword: any (default) or all of the phrases.

string
Allowed values: any all
mode

Variable (required): all or any of the rules.

string
Allowed values: all any
outcome

Outcome (required): the result of an action or collect node.

string
Allowed values: success error timeout collected max_retries invalid busy no_answer returned transferred failed sent answered not_found scheduled done open closed holiday recorded no_message
phrases

Keyword (required): phrases the caller says; a trailing * matches a prefix.

Array<string>
<= 100 items
rules

Variable (required): the rules.

Array<object>
<= 50 items

A rule on a variable.

object
op
required
string
Allowed values: eq neq gt gte lt lte contains not_contains matches exists empty in not_in
value
Any of:
string
<= 2000 characters
var
required

A variable key, e.g. budget, contact.city, api.status.

string
<= 120 characters
times

No_response: in a row (default 1).

integer
>= 1 <= 10
max_per_call
required
integer
>= 1 <= 100
priority
required

Higher wins when several global nodes match.

number
scope
required

Where in the call the trigger listens.

object
node_keys

Only / except: the nodes it applies to (or not).

Array<string>
type
required
string
Allowed values: everywhere only except
hours

Type hours: Branch on opening hours: open, closed or holiday.

object
closed_dates

Extra closed days, YYYY-MM-DD.

Array<string>
<= 400 items
holidays

Closed on Israeli holidays (the holiday outcome).

boolean
open_dates

Exceptional open days, YYYY-MM-DD.

Array<string>
<= 400 items
shabbat

Closed on Shabbat (Israel).

boolean
timezone

IANA time zone (default: the flow’s).

string
<= 60 characters
windows
Array<object>
<= 50 items
object
days
required

0 = Sunday … 6 = Saturday.

Array<integer>
end
required

HH:MM

string
<= 5 characters
start
required

HH:MM

string
<= 5 characters
integration

Type integration: Run a connected CRM or calendar action during the call (look the caller up, add a note, create a task): success, not found or error.

object
action

The action, e.g. crm.lookup_contact, crm.add_note, crm.create_task.

string
<= 120 characters
args

The action’s arguments by name ({{templates}} allowed).

object
key
additional properties
string
<= 4000 characters
integration_connection_id

The connected integration account (Settings › Integrations). Integration connections have no API object (and no public ID prefix) yet: the id is the dashboard’s.

string
<= 64 characters
result_map

Result fields → variables (e.g. contacts[0].name → customer_name).

Array<object>
<= 100 items
object
path
required

E.g. data.items[0].name

string
<= 500 characters
var
required
string
<= 120 characters
wait_text

Said while the action runs.

string
<= 1000 characters
internal

Type internal: a node of a type outside the v1 schema (SMS, e-mail, voicemail, callbacks, agent-script steps…). Read-only: when you write the draft, the stored node is kept; only its transitions’ next may change.

object
raw
object
key
additional properties
type
string
<= 64 characters
kb_answer

Type kb_answer: Answer from the knowledge base.

object
answer_style
string
<= 1000 characters
document_ids

Empty: the whole knowledge base.

Array<string>
<= 200 items
min_score
number
<= 1
not_found_text
string
<= 4000 characters
key
required

The node’s key: your stable identifier, unique in the graph.

string
/^[A-Za-z0-9_.:-]{1,64}$/
position

Default: laid out automatically.

object
x
required
number
y
required
number
post_api

Type post_api: Call an HTTP API after the call.

object
auth

How the request authenticates. Reference credentials as {{secrets.NAME}} rather than in clear.

object
header

Api_key / hmac (required): the header name.

string
<= 200 characters
password

Basic (required).

string
<= 4000 characters
secret

Hmac (required): the signing secret.

string
<= 4000 characters
token

Bearer (required).

string
<= 4000 characters
type
required
string
Allowed values: none bearer basic api_key hmac
username

Basic (required).

string
<= 500 characters
value

Api_key (required).

string
<= 4000 characters
body

The body template ({{templates}} JSON-escaped when body_type is json).

string
<= 100000 characters
body_type
string
Allowed values: json form none
headers
Array<object>
<= 100 items
object
key
required
string
<= 200 characters
value
required
string
<= 4000 characters
method
string
Allowed values: GET POST PUT PATCH DELETE
query
Array<object>
<= 100 items
object
key
required
string
<= 200 characters
value
required
string
<= 4000 characters
response_map

Response fields → variables.

Array<object>
<= 100 items
object
path
required

E.g. data.items[0].name

string
<= 500 characters
var
required
string
<= 120 characters
retries
integer
<= 5
success_when

When the response counts as a success (default: any 2xx).

object
mode
required
string
Allowed values: all any
rules
required
Array<object>
<= 50 items

A rule on a variable.

object
op
required
string
Allowed values: eq neq gt gte lt lte contains not_contains matches exists empty in not_in
value
Any of:
string
<= 2000 characters
var
required

A variable key, e.g. budget, contact.city, api.status.

string
<= 120 characters
timeout_ms
integer
>= 100 <= 60000
url

The URL ({{templates}} allowed).

string
<= 4000 characters
wait_text

Said while waiting.

string
<= 1000 characters
post_integration

Type post_integration: Run a connected CRM action after the call (add a note, create a follow-up task).

object
action

The action, e.g. crm.lookup_contact, crm.add_note, crm.create_task.

string
<= 120 characters
args

The action’s arguments by name ({{templates}} allowed).

object
key
additional properties
string
<= 4000 characters
integration_connection_id

The connected integration account (Settings › Integrations). Integration connections have no API object (and no public ID prefix) yet: the id is the dashboard’s.

string
<= 64 characters
result_map

Result fields → variables (e.g. contacts[0].name → customer_name).

Array<object>
<= 100 items
object
path
required

E.g. data.items[0].name

string
<= 500 characters
var
required
string
<= 120 characters
question

Type question: Ask for one detail, validate it and store it in a variable.

object
audio_id

A audio asset ID (aud_…).

string
<= 200 characters /^aud_[0-9A-Za-z]+$/
confirm

Read the answer back for confirmation.

boolean
dtmf_input

Accept the answer on the keypad too.

object
inter_digit_ms
integer
>= 500 <= 15000
log_digits
boolean
max_digits
required
integer
>= 1 <= 40
terminator
string
<= 2 characters
max_retries
integer
<= 10
prompt
string
<= 4000 characters
reask_prompts
Array<string>
<= 10 items
validation
object
options
Array<string>
<= 200 items
pattern
string
<= 400 characters
type
string
Allowed values: text number boolean date phone email enum json
var

The variable the answer is stored in.

string
<= 120 characters
say

Type say: Say an exact line, or one the AI rephrases.

object
audio_id

An uploaded prompt played instead of speech.

string
<= 200 characters /^aud_[0-9A-Za-z]+$/
interruptible
boolean
mode
string
Allowed values: verbatim rephrase
style
string
<= 500 characters
text
string
<= 4000 characters
set_variable

Type set_variable: Set variables.

object
assignments
Array<object>
<= 100 items
object
value
required

A literal or a {{template}}.

string
<= 4000 characters
var
required
string
<= 120 characters
start

Type start: Where every call begins: the greeting.

object
first_message_mode
string
Allowed values: speak wait generate
greeting
string
<= 4000 characters
interruptible
boolean
title
string
<= 200 characters
transfer

Type transfer: Transfer the call to a queue, a number, another flow or a SIP address.

object
announce_text
string
<= 1000 characters
assistant_id

A assistant ID (asst_…).

string
<= 200 characters /^asst_[0-9A-Za-z]+$/
destination

A phone number, or a SIP URI for mode sip.

string
<= 200 characters
flow_id

A flow ID (flow_…).

string
<= 200 characters /^flow_[0-9A-Za-z]+$/
mode
string
Allowed values: queue number flow sip participant
queue_id

A queue ID (q_…).

string
<= 200 characters /^q_[0-9A-Za-z]+$/
screen_pop_vars
Array<string>
<= 50 items
timeout_seconds
integer
>= 1 <= 600
whisper_summary

Warm transfer: whisper an AI summary to the receiving side first.

boolean
transitions

The node’s outputs, in priority order. Default: the type’s standard outputs (a new node) or the stored ones.

Array<object>
<= 60 items

A node output: when its condition matches, the call moves to next.

object
condition
required

When a transition is taken: kind and that kind’s fields.

object
after_seconds

No_response (required): seconds of silence.

number
>= 1 <= 600
description

Intent (required): what the caller means.

string
<= 2000 characters
digits

Dtmf (required): keypad digits — 1, *, # or a range 1-3.

string
<= 20 characters
examples

Intent: example phrasings.

Array<string>
<= 50 items
kind
required

Intent: the AI decides what the caller means · keyword · variable rules (no AI) · dtmf keys · always (right after the node) · no_response · outcome of an action · else (the fallback, last).

string
Allowed values: intent keyword variable dtmf always no_response outcome else
match

Keyword: any (default) or all of the phrases.

string
Allowed values: any all
mode

Variable (required): all or any of the rules.

string
Allowed values: all any
outcome

Outcome (required): the result of an action or collect node.

string
Allowed values: success error timeout collected max_retries invalid busy no_answer returned transferred failed sent answered not_found scheduled done open closed holiday recorded no_message
phrases

Keyword (required): phrases the caller says; a trailing * matches a prefix.

Array<string>
<= 100 items
rules

Variable (required): the rules.

Array<object>
<= 50 items

A rule on a variable.

object
op
required
string
Allowed values: eq neq gt gte lt lte contains not_contains matches exists empty in not_in
value
Any of:
string
<= 2000 characters
var
required

A variable key, e.g. budget, contact.city, api.status.

string
<= 120 characters
times

No_response: in a row (default 1).

integer
>= 1 <= 10
key

The transition’s key (an output port), unique in the node. Default: a new key.

string
>= 1 characters <= 64 characters
label
string
<= 200 characters
next
Any of:

The node’s key: your stable identifier, unique in the graph.

string
/^[A-Za-z0-9_.:-]{1,64}$/
type
required

The node type. Its settings are under the property of the same name (type: "say" → say: {…}).

string
Allowed values: start say question ai_agent kb_answer api post_api integration post_integration set_variable decision dtmf_menu hours transfer end internal
schema_version
number
Allowed value: 1
settings

Merged with the stored settings.

object
classifier_model
Any of:
string
<= 60 characters
fallback_node_key
Any of:

The node’s key: your stable identifier, unique in the graph.

string
/^[A-Za-z0-9_.:-]{1,64}$/
global_prompt

Persona and global instructions, combined with the assistant’s prompt.

string
<= 20000 characters
ivr
Any of:
object
inter_digit_ms
integer
>= 500 <= 15000
max_invalid_total
integer
>= 1 <= 50
no_input_seconds
number
>= 1 <= 60
operator
Any of:
object
announce_text
string
<= 1000 characters
destination
string
<= 200 characters
mode
required
string
Allowed values: queue number
queue_id
Any of:

A queue ID (q_…).

string
<= 200 characters /^q_[0-9A-Za-z]+$/
operator_key
string
<= 2 characters
repeat_key
string
<= 2 characters
speech

Off: keypad only; keywords: spoken choices matched to the options; smart: keywords, then an AI routing check.

string
Allowed values: off keywords smart
timezone
string
<= 60 characters
voice
object
language_code
required
string
<= 10 characters
model
required
string
<= 80 characters
style
required
string
<= 500 characters
voice_name
required
string
<= 120 characters
language
string
<= 10 characters
max_chain_steps
integer
>= 1 <= 500
max_transitions
integer
>= 1 <= 5000
max_turns_per_node
integer
>= 1 <= 100
max_visits_per_node
integer
>= 1 <= 100
on_pre_call_fail
string
Allowed values: continue end
pre_call_timeout_ms
integer
>= 200 <= 20000
style_field
string
Allowed values: auto off
transition_model

Inline: the reply decides the transition; classifier: a separate fast check.

string
Allowed values: inline classifier
variables

Default: the stored variables.

Array<object>
<= 500 items
object
default
string
<= 2000 characters
description
string
<= 1000 characters
key
required
string
>= 1 characters <= 80 characters
label
required
string
<= 120 characters
options
Array<string>
<= 200 items
pattern
string
<= 400 characters
sample

A sample value for simulations and tests.

string
<= 2000 characters
sensitive

Redacted in logs, metrics and analytics.

boolean
source
required

Where its value comes from: the contact, a pre-call API, collected in the call, an API, set by a node, the system, or extracted after the call.

string
Allowed values: contact precall collected api set system extracted
type
required
string
Allowed values: text number boolean date phone email enum json
kind
string
default: voice
Allowed values: voice agent_script ivr
language

The template’s / empty flow’s language (default he).

string
Allowed values: he en
name
required
string
>= 1 characters <= 200 characters
template_id

Start from a template instead of an empty flow.

string
<= 80 characters
Example
{
  "kind": "voice",
  "language": "en",
  "name": "Reception"
}

Responses

Section titled “Responses”

201

Section titled “201”

The new flow.

Media typeapplication/json

A call flow: an editable draft and its published, immutable versions.

object
assistant_id
required
Any of:

A assistant ID (prefix asst_).

string
/^asst_[0-9A-Za-z]+$/
description
required
string
draft_rev
required

The draft’s revision: send it as base_rev when you write the draft.

integer
>= -9007199254740991 <= 9007199254740991
id
required

The flow’s ID.

string
/^flow_[0-9A-Za-z]+$/
kind
required

Voice: drives an AI assistant; agent_script: a human agent’s branching script; ivr: a phone menu.

string
Allowed values: voice agent_script ivr
latest_version
required
integer
>= -9007199254740991 <= 9007199254740991
livemode
required

true in live mode, false in test mode.

boolean
name
required
string
node_count
required
integer
>= -9007199254740991 <= 9007199254740991
object
required
string
Allowed value: flow
published_version
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
status
required
string
Allowed values: draft published archived
template_id
required
string | null
updated
required

An ISO-8601 timestamp in UTC.

string format: date-time
Example
{
  "assistant_id": "asst_3cYbE6uYvGkH8w4ZK1rTqd",
  "description": "Identify the caller and route them.",
  "draft_rev": 17,
  "id": "flow_7Kp1Ns4Vy6Ab9Dg2Hj5Lm8",
  "kind": "voice",
  "latest_version": 3,
  "livemode": true,
  "name": "Reception",
  "node_count": 12,
  "object": "flow",
  "published_version": 3,
  "status": "published",
  "template_id": null,
  "updated": "2026-11-03T09:14:22.000Z"
}

400

Section titled “400”

The request is invalid: a parameter is missing, malformed or unknown, or the version header is unknown.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "parameter_missing",
    "doc_url": "https://docs.morevoice.ai/api/errors#parameter-missing",
    "message": "Missing required parameter: to.",
    "param": "to",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "invalid_request_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

401

Section titled “401”

No valid API key was sent.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "invalid_api_key",
    "doc_url": "https://docs.morevoice.ai/api/errors#invalid-api-key",
    "message": "Invalid API key.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "authentication_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

403

Section titled “403”

The key may not do this (a missing scope, a plan limit, or a compliance block).

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "missing_scope",
    "doc_url": "https://docs.morevoice.ai/api/errors#missing-scope",
    "message": "This API key lacks the calls:write scope.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "permission_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

409

Section titled “409”

The request conflicts with the object’s state, or the Idempotency-Key was reused with other parameters.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "idempotency_mismatch",
    "doc_url": "https://docs.morevoice.ai/api/errors#idempotency-mismatch",
    "message": "This Idempotency-Key was already used with different parameters.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "idempotency_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

429

Section titled “429”

Too many requests, or no call capacity right now. Retry after the Retry-After delay.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "rate_limited",
    "doc_url": "https://docs.morevoice.ai/api/errors#rate-limited",
    "message": "Too many requests. Retry after 1 second.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "rate_limit_error"
  }
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.

X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

500

Section titled “500”

Something went wrong on MoreVoice’s side. Retry with the same Idempotency-Key.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "internal_error",
    "doc_url": "https://docs.morevoice.ai/api/errors#internal-error",
    "message": "Something went wrong on MoreVoice's side.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "api_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.