Get an Agent

Read one Agent's complete setup: instructions, first message, language, time zone, settings, integration tools (each with its connection and effect), Knowledge document ids, procedures (trigger plus free-form instructions or structured steps) and connection procedures, and channels. ready says whether it can hold conversations; for a voice Agent, synced says whether its phone line already runs this version, and syncErrorCode why not. Read it before update_agent and send its version as expectedVersion.

Scopes: any one of raiz:agents:read, raiz:agents:write
Credentials: an API key, a client-credentials token or a person's access token
Effect: read-only; safe to retry
Limits: response up to 1 MB
CLI: arbol raiz agents get · MCP tool: raiz_agents_get

GET

https://api.getarbol.com/v1/raiz/agents/{agentId}

Authorization

Authorization
string
required
Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with any one of the scopes raiz:agents:read, raiz:agents:write. Get an API key.

Path parameters

agentId
string
required
Agent id.

pattern: ^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$

Returns

200

Successful operation.

JSON

success
boolean
required
data
object
required
- channelCount
  integer
  required
  minimum: 0
- createdAt
  string
  required
  An instant in RFC 3339 format, in UTC.
  
  format: date-time
- description
  string | null
  required
- firstMessage
  string | null
  required
- id
  string
  required
  Agent id.
  
  pattern: ^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
- language
  string
  required
  BCP 47 language tag.
- modality
  voice
  or
  text
  required
  voice: phone calls. text: WhatsApp and web chat.
- name
  string
  required
- ready
  boolean
  required
  Whether the Agent can hold conversations: active, with instructions and, for voice, published for calls.
- status
  active
  or
  paused
  required
  A paused Agent answers nothing and places no calls.
- syncErrorCode
  string | null
  required
  Why calls still use an older version: the error code of the last publication attempt. Null while synced or while a publication is pending. A fix to the Agent (a valid voiceId, instructions) publishes again.
- synced
  boolean
  required
  Whether calls already use the current version (it is published on the Agent's voice channels). Always true for text Agents.
- timeZone
  string | null
  required
  IANA time zone.
- toolCount
  integer
  required
  minimum: 0
- updatedAt
  string
  required
  An instant in RFC 3339 format, in UTC.
  
  format: date-time
- version
  integer
  required
  minimum: 1
- channels
  array of
  object
  required
  Channels assigned to the Agent. Assign one with updateChannel.
  
  address
  string | null
  required
  Phone number or web address of the channel.
  
  channelType
  voice
  or
  whatsapp
  or
  web
  required
  id
  string
  required
  Channel id.
  
  pattern: ^(?:chn_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))|(?:agc)_(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
  name
  string | null
  required
  status
  pending
  or
  active
  or
  degraded
  required
  lastBusinessAppGreetingAt
  optional
  string | null
  WhatsApp only. Last observed message from the phone app matching the configured greeting. Null when none has been recognized. The phone's current greeting setting is unknown.
  
  format: date-time
- instructions
  string | null
  required
- integrationProcedures
  array of
  object
  required
  The procedures the Agent takes from its connections, each saved with the text its connection published then. They run as free-form procedures beside procedures.
  
  connectionId
  string
  required
  A connection's id in Account (con_…).
  
  maxLength: 255 · minLength: 1 · pattern: ^[A-Za-z0-9_-]+$
  digest
  string
  required
  The digest of the procedure the Agent was saved with. When the connection's procedure (listConnections) has another digest, it changed: the Agent keeps this text until it is saved again.
  
  maxLength: 64 · minLength: 1
  procedure
  string
  required
  The procedure's name, as its connection lists it.
  
  maxLength: 64 · minLength: 1 · pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
- integrationTools
  array of
  object
  required
  The integrations' tools the Agent may call, each on the connection it runs on, with the definition it was saved with.
  
  connectionId
  string
  required
  A connection's id in Account (con_…).
  
  maxLength: 255 · minLength: 1 · pattern: ^[A-Za-z0-9_-]+$
  digest
  string
  required
  The digest of the definition the Agent was saved with. When the connection's tool (listConnections) has another digest, the tool changed: the Agent keeps this definition until it is saved again.
  
  maxLength: 64 · minLength: 1
  effect
  read
  or
  write
  required
  read only looks; write may change data.
  
  tool
  string
  required
  The tool's name, as its connection lists it.
  
  maxLength: 128 · minLength: 1 · pattern: ^[A-Za-z0-9_.-]+$
  toolsVersion
  string
  required
  The connection's tool-list version when the Agent was saved.
- knowledgeDocumentIds
  array of
  string
  required
  The Knowledge documents the Agent consults.
  
  pattern: ^(?:kdc_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))|(?:con)_(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
- procedures
  array of
  object
  required
  The Agent's procedures. The model reads only the triggers until a conversation matches one, then loads that procedure. In an update, the complete new set.
  
  content
  string
  required
  Free-form procedures: what to do, in Markdown, with inline references such as [tool id="buscar_citas"], [kb id="kdc_…"], [procedure id="prc_…"], [system_tool id="end_conversation"] and {{contact_name}}. Empty for structured procedures.
  
  maxLength: 50000
  id
  string
  required
  The procedure's id (prc_…), stable for the Agent's life.
  
  pattern: ^prc_[0-7][0-9a-hjkmnp-tv-z]{25}$
  name
  string
  required
  A short label for people. The model never reads it.
  
  maxLength: 120 · minLength: 1
  status
  active
  or
  paused
  required
  A paused procedure runs on no channel.
  
  steps
  array of
  required
  Structured procedures: the steps, in order. Empty for free-form procedures.
  
  One of the following:
  object
  object
  object
  object
  object
  object
  object
  trigger
  string
  required
  When it applies, from the contact's side: When the contact asks to book or move an appointment. Empty makes a sub-procedure, which only runs when another procedure references it.
  
  maxLength: 1000
  type
  free_form
  or
  structured
  required
  free_form: instructions the Agent adapts. structured: steps that run the same way every time. Fixed once created.
- settings
  object
  required
  humanEscalation
  object | null
  required
  Per-Agent human escalation policy. Instructions apply to voice and text. Null keeps the default instructions. A WhatsApp handoff stays with the team until a person explicitly resumes AI; no timeout resumes it.
  
  instructions
  string | null
  required
  When this Agent should ask the business's team to intervene, using only its available handoff capabilities. Null keeps the default instructions; an explicit request for a person is always respected.
  
  maxLength: 4000
  recoveryManager
  object | null
  required
  Optional WhatsApp recovery advisor. Null or enabled=false disables it. A journaled evidence check precedes any paid review. One tool-free model call per turn before autonomous escalation or after terminal provider failure; unresolved terminal recovery hands off. Completed handoffs and conservatively recognized human requests bypass generation. Model selects the existing provider route. Prices must be conservative upper bounds including provider overhead; missing or invalid prices disable recovery. The cost bound covers only the advisor. No tools or automatic provider retries.
  
  enabled
  boolean
  required
  model
  arbolito/agile
  or
  arbolito/balanced
  or
  arbolito/advanced
  or
  arbolito/top
  required
  arbolito/agile: quickest and least expensive, for direct conversations. arbolito/balanced: more deliberate answers at moderate cost. arbolito/advanced: strong reasoning for complex instructions and many tools, with an adjustable reasoningEffort. arbolito/top: the most capable, for the hardest cases, with an adjustable reasoningEffort up to xhigh. Every tier reads images and PDF documents.
  
  maxAttempts
  number
  required
  timeoutMs
  integer
  required
  maximum: 15000 · minimum: 100
  maxInputTokens
  integer
  required
  maximum: 131072 · minimum: 4096
  maxOutputTokens
  integer
  required
  maximum: 1024 · minimum: 128
  maxCostUsd
  number
  required
  maximum: 1
  inputUsdPerMillion
  number
  required
  maximum: 1000
  outputUsdPerMillion
  number
  required
  maximum: 1000
  instructions
  optional
  string | null
  Operator criteria for when the recovery advisor should help or leave the case to a person. They never override consent, tool permissions, unknown-write fences or an explicit human request. Null keeps the default criteria.
  
  maxLength: 4000
  advisorAgentId
  optional
  string | null
  Optional active text Agent in the same organization, other than this Agent, whose instructions and procedures provide specialist guidance. The configured recovery model and cost bounds stay unchanged; no specialist tools or conversation history are accessed.
  
  pattern: ^agt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$
  automaticKnowledge
  boolean | null
  required
  Text Agents. Retrieve relevant passages from this Agent's active Knowledge before a substantive contact message, without a model tool call. Null or false: on-demand search only. Does not store contact memories or learn unreviewed answers.
  
  attachmentReader
  vision
  or
  ocr
  or
  null
  required
  Text Agents on WhatsApp. Who reads an image or PDF when the Agent calls read_attachment: vision (a vision model describes and transcribes it, with a stronger one when the first reads nothing) or ocr (text recognition, which also answers the fields the Agent asks for, each null when absent or unclear; the vision model reads the file when recognition cannot). With ocr the Agent sees files as markers and reads them with read_attachment; with vision, tiers that read files themselves see the original. Null: vision.
  
  budgetExhaustedMessage
  string | null
  required
  Text Agents on WhatsApp. What the contact reads when the Agent has used its monthlyTokenBudget: the conversation then goes to the team, as an escalation does, and the Agent writes nothing until the budget is raised or the month ends. Null: handoffMessage, including an empty notice when disabled.
  
  maxLength: 1000 · minLength: 1
  closingMessage
  string | null
  required
  Text Agents on WhatsApp. After a reply that completed an action (an integration tool that changes data succeeded), explicitly finished the case with end_conversation and left nothing pending (no question, no offered choices, no handoff), a contact message that only thanks or closes («gracias», «ok», «listo», an emoji) gets this text at once, without the model; the Agent still reads both in its next turn. Write it in the Agent's language and ask nothing in it. Null: the Agent answers such messages itself.
  
  maxLength: 1000 · minLength: 1
  evalGate
  boolean | null
  required
  Text and voice Agents. When true, an updateAgent that changes what the model reads (instructions, procedures, connection procedures, model or reasoningEffort) must send evalRunId: a completed createEvalRun of this Agent with exactly that content, in which every case passed (EVAL_GATE_UNMET otherwise). Null: no requirement.
  
  followUpAfterMinutes
  integer | null
  required
  Text Agents. When the Agent spoke last and asked something, send followUpMessage once after this many minutes of silence (WhatsApp only, inside its 24-hour window). Null disables follow-ups.
  
  maximum: 1440 · minimum: 1
  followUpMessage
  string | null
  required
  Text Agents. The follow-up text. Null uses a short default in the Agent's language.
  
  maxLength: 1000 · minLength: 1
  greeting
  required
  One of the following:
  RaizAgentGreeting
  null
  handoffMessage
  string | null
  required
  Text Agents on WhatsApp. The notice appended after an escalation or a requested human handoff. Null: the current localized review notice or the case-specific notice supplied under the Agent's instructions. An empty string disables the notice; the handoff and pause still happen. The model does not write this notice.
  
  maxLength: 1000
  humanReplyTimeoutMinutes
  integer | null
  required
  Text Agents on WhatsApp. After a manual takeover, resume automatic replies when the contact's newest message waits this many minutes. An Agent handoff always stays with the team until a person explicitly resumes AI. Null: only a person resumes automatic replies.
  
  maximum: 1440 · minimum: 1
  investigationsEnabled
  boolean | null
  required
  Opt this Agent into internal root-cause investigations of tool failures, human escalations, failed outcomes and negative feedback. Incidents are grouped only with participating Agents in the same organization. Null or false: disabled. Turning this off stops new events and pending dispatch when no participating Agent remains; an already active investigation may finish.
  
  model
  arbolito/agile
  or
  arbolito/balanced
  or
  arbolito/advanced
  or
  arbolito/top
  or
  null
  required
  Text Agents. The tier that writes replies. arbolito/agile: quickest and least expensive, for direct conversations. arbolito/balanced: more deliberate answers at moderate cost. arbolito/advanced: strong reasoning for complex instructions and many tools, with an adjustable reasoningEffort. arbolito/top: the most capable, for the hardest cases, with an adjustable reasoningEffort up to xhigh. Every tier reads images and PDF documents. Null: the default, as arbolito/agile.
  
  modelTrial
  required
  One of the following:
  RaizAgentModelTrial
  model
  arbolito/agile
  or
  arbolito/balanced
  or
  arbolito/advanced
  or
  arbolito/top
  required
  The tier the trial's conversations are answered with.
  
  percent
  integer
  required
  The share of new conversations in the trial, in percent.
  
  maximum: 50 · minimum: 1
  reasoningEffort
  none
  or
  low
  or
  medium
  or
  high
  or
  xhigh
  or
  null
  required
  The trial tier's reasoning, as reasoningEffort. Null: the tier's default.
  
  null
  monthlyTokenBudget
  integer | null
  required
  Text Agents. Tokens (input, cached input included, plus output) the Agent may use per calendar month (UTC), on every channel. On WhatsApp, a reply that would start past it does not run: the contact reads budgetExhaustedMessage and the team continues; at 80 % the API logs an alert once a month. Null: no limit.
  
  maximum: 1000000000000 · minimum: 10000
  pauseOnHumanReply
  boolean | null
  required
  Text Agents on WhatsApp: pause automatic replies when a live WhatsApp Business App message that says something (not a reaction, an edit or a deletion) proves a person took over. Null: disabled. The recipient stays paused until resumed or until that conversation closes; their next conversation starts with the AI.
  
  policy
  required
  One of the following:
  RaizAgentTurnPolicy
  maxOutputTokens
  optional
  integer
  Output tokens per model call, reasoning included. Default 4096.
  
  maximum: 16384 · minimum: 256
  maxSteps
  optional
  integer
  Model calls one reply may make: tool rounds plus the answer. The last call never offers tools, so the contact always gets an answer. Default 16.
  
  maximum: 32 · minimum: 2
  maxWritesPerStep
  optional
  integer
  Integration tool calls that change data (effect: write) one model step may run. A further one is refused with a fixed reason, and the Agent runs it in its next step after reading the first result. 0 forbids writes. Default 1.
  
  maximum: 3 · minimum: 0
  repeatedReadLimit
  optional
  integer
  Identical reads (same tool, same arguments) one reply may run; the next is refused with a fixed reason. Omitted: no limit, as an Agent that polls a pending operation repeats one read on purpose.
  
  maximum: 10 · minimum: 1
  tools
  optional
  object
  Per-tool rules, by the name the model sees.
  
  null
  pollPendingOperations
  boolean | null
  required
  Text Agents on WhatsApp: when a reply ends while an integration answered that its work is still pending (status: pending with an operationId) and the same connection offers getOperation, Raíz checks it again on its own and the Agent answers with the result, without waiting for the contact to write. Null: disabled.
  
  reasoningEffort
  none
  or
  low
  or
  medium
  or
  high
  or
  xhigh
  or
  null
  required
  Text Agents whose tier reasons (arbolito/advanced, arbolito/top, or an Agent already running a model that reasons): none answers fastest, high deliberates most, and xhigh, on arbolito/advanced and arbolito/top, deliberates past it. Null: the tier's default. A tier that does not reason refuses it (AGENT_SETTINGS_INVALID).
  
  replyChoices
  boolean | null
  required
  Text Agents. Let the Agent offer tap-to-answer options (WhatsApp buttons and lists, web reply options). Null: allowed.
  
  sessionCloseAfterMinutes
  integer | null
  required
  Text Agents. Close a conversation after this many minutes without messages. Null: 1440 on WhatsApp, 30 on web.
  
  maximum: 10080 · minimum: 5
  temperature
  number | null
  required
  Text Agents. Sampling temperature of replies. Null: 0.2 (steady answers). arbolito/advanced and arbolito/top set their own sampling and ignore it.
  
  maximum: 1 · minimum: 0
  toolDiscovery
  boolean | null
  required
  Retired: changes nothing. WhatsApp replies (the WhatsApp Agent Worker) offer the Agent's tools directly. Accepted so existing clients that send it stay valid.
  
  voice
  required
  One of the following:
  RaizAgentVoiceSettings
  keywords
  array of
  string
  required
  Names and terms the transcriber should favor (people, places, products).
  
  maxLength: 64 · minLength: 1
  maxDurationSeconds
  integer | null
  required
  Hard limit of one call. Null: 600 seconds.
  
  maximum: 7200 · minimum: 30
  recordCalls
  boolean
  required
  Keep the call recording (copied to Raíz after the call).
  
  silenceEndCallTimeoutSeconds
  integer | null
  required
  Hang up after this much caller silence. Null: the platform default.
  
  maximum: 600 · minimum: 10
  similarityBoost
  number | null
  required
  maximum: 1 · minimum: 0
  speed
  number | null
  required
  maximum: 1.2 · minimum: 0.7
  stability
  number | null
  required
  maximum: 1 · minimum: 0
  turnTimeoutSeconds
  integer | null
  required
  Seconds to wait for the caller before prompting again. Null: the platform default.
  
  maximum: 30 · minimum: 1
  llm
  arbolito/agile
  or
  arbolito/balanced
  or
  arbolito/advanced
  or
  arbolito/top
  or
  null
  required
  The tier the Agent thinks with on calls. arbolito/agile: quickest and least expensive, for direct conversations. arbolito/balanced: more deliberate answers at moderate cost. arbolito/advanced: strong reasoning for complex instructions and many tools, with an adjustable reasoningEffort. arbolito/top: the most capable, for the hardest cases, with an adjustable reasoningEffort up to xhigh. Every tier reads images and PDF documents. Null: the default, as arbolito/agile.
  
  voiceId
  string | null
  required
  A voice from listVoices. Null uses the default voice.
  
  pattern: ^vce_[A-Za-z0-9_-]{20,156}$
  redactKeypadInput
  optional
  boolean
  Replace numbers entered on the phone keypad with <REDACTED> in stored transcripts and analysis. False (the default) keeps them visible. Applies to future calls; the Agent still receives the digits during the call.
  
  default: false
  reasoningEffort
  optional
  none
  or
  minimal
  or
  low
  or
  medium
  or
  high
  or
  xhigh
  +2 more
  Reasoning effort on calls, when supported by the selected model. Null uses the model default.
  
  responseDelayMessages
  optional
  boolean
  Speak a short contextual message while preparing a slow response. False disables automatic delay messages. Omitted preserves the current runtime setting.
  
  toolCallSound
  optional
  typing
  or
  null
  
  typing: Play a typing sound while this Agent's tools execute. Null disables the sound; omitted preserves the current setting. Applies to future calls after synchronization.
  
  backupModels
  optional
  array | null
  Ordered backup tiers when the primary voice model fails. Null restores the runtime default. Omitted preserves the current runtime setting. An empty list is not allowed because calls need a fallback.
  
  null
}
error
null
required
metadata
object
required
- requestId
  string
  required
  Request correlation identifier, also sent as X-Request-Id.
}

400

INVALID_INPUT: The request does not match the published schema.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

401

UNAUTHORIZED: A valid access token is required.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

403

FORBIDDEN: The token does not authorize this operation.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

404

NOT_FOUND: The requested operation does not exist.
RESOURCE_NOT_FOUND: The requested resource does not exist in this organization.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

405

HTTP_METHOD_NOT_ALLOWED: The HTTP method is not supported for this resource.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

413

REQUEST_TOO_LARGE: The request exceeds the allowed size.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

415

UNSUPPORTED_MEDIA_TYPE: The request content type is not supported.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

429

RATE_LIMITED: The request rate limit was exceeded. Try again later.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

500

INTERNAL_ERROR: The service could not complete the operation.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

502

OUTCOME_UNKNOWN: The operation may have been applied; check its result before repeating it.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

503

UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.
VOICE_UNAVAILABLE: Calls are unavailable right now. Try again in a few minutes.
INTEGRATIONS_UNAVAILABLE: The organization's integrations cannot be read right now. Try again shortly.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

504

UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}