VocalDocscontracts 1.65.0

ErrorDetail

One issue behind an error.

An object with 16 fields.

Fields

FieldTypeRequiredDescription
agent_idAgentIdnoOn knowledge_base_version_in_use with the reason pinned (1.54.0): the Agent whose version pins the Knowledge base version, the first the api finds; on prompt_template_in_use with the reason agent_version (1.55.0), the Agent whose active version pins the template or names it as its Organization layer.
agent_versionintegernoWith agent_id (1.54.0): the number of the Agent version that pins the Knowledge base version; from 1.63.0, on evaluation_gate_failed, the version whose activation the gate refused.
codestringyesA snake_case code for this one issue, such as type_error. The validation issues the contracts compute are setting_conflict, setting_out_of_bounds, setting_locked, from 1.10.0 provider_not_allowed, from 1.17.0 capability_mismatch, template_invalid, variable_missing, variable_unknown, variable_type and the warning variable_unused, from 1.18.0 setting_override_not_allowed and setting_unknown, from 1.20.0 interrupt_word_not_ignorable, from 1.24.0 disclosure_attestation_required, the issues the api raises from 1.28.0 on the Organization Provider credential routes, credential_mode_unavailable (the descriptors of the Provider do not list byok) and credential_invalid (the vendor refused the key when it was entered), each with provider set, and from 1.32.0 variable_phi_default (a default on a variable declared phi), region_not_in_cell (a Compliance profile region the cell does not allow) and owner_required, the one detail of the forbidden that refuses a Compliance profile update from an API key or from a Member who is not an owner, and from 1.34.0 operator_role_not_grantable, the one detail of the forbidden that refuses a write giving the operator role in an Organization that is not the operator Organization or to a caller that is not an operator, at path /role, and from 1.38.0 the issues of a new vendor price entry, price_not_positive (a unit price not above 0), price_effective_in_past (an effective_from before the transaction), price_above_ceiling (a unit price above price_ceiling_factor times the highest price in force of its unit) and price_not_replaceable (an entry that would replace a row in force or ended), and from 1.42.0 setting_not_settable_at_layer (a value that the layer setting it may not set, such as safety.disclosure.required false in a platform settings entry, which only the Organization layer may set; with layer), raised by PATCH /v1/platform/settings and, for a value an Agent version may not set, by publish, and from 1.45.0 the SignInRefusalCode values sign_in_pending, member_disabled, email_unverified, email_held, ambiguous_membership and unknown_role, and from 1.51.0 invitation_expired, the one detail of the forbidden that refuses a Member ID token whose identity is not a Member, at path /headers/authorization, and from 1.47.0 the PolicyIssueCode values of a Policy, its JDM document and its attachment to an Agent version, such as rules_node_type_not_allowed, policy_field_unavailable_at_hook and illegal_action_for_hook, each with path and, when it concerns a node, node_id, and policies_admin_required, the one detail of the forbidden that refuses an organization-scoped Policy write, or the disabling of a compliance-tagged Policy, to a caller without policies:admin, and from 1.49.0 the ToolIssueCode values of a Tool and its attachment to an Agent, such as tool_name_reserved, tool_parameters_invalid, egress_denied (with an EgressDenialReason in reason), phi_in_query_string and tool_reference_unknown, and from 1.50.0 destination_not_allowed (a key of the transfer_destinations of an Agent that is not on the transfer allowlist of its Organization) and transfer_destination_not_dialable (an allowlist number the dial policy refuses, with a DialRefusalReason in reason), answering_machine_message_required (leave_message with no voicemail message at any layer) and voicemail_phi_variable (a variable declared phi in the voicemail message, in PHI mode), and from 1.52.0 the EventFilterIssueCode values of an event filter (event_filter_empty, event_filter_value_repeated) and the WebhookSelectionIssueCode values of what a Webhook subscription receives (event_selection_empty, include_requires_post_call, include_not_allowed_in_phi_mode), and the ReplayWindowIssueCode values of a window replay (replay_window_inverted, replay_window_out_of_range, replay_window_too_large), and the PreCallHookIssueCode values of a pre-call hook, such as pre_call_hook_scope_taken and phi_attestation_required at /status, and from 1.53.0 the KnowledgeBaseIssueCode values of a Knowledge base draft (such as embedding_model_unknown and chunk_overlap_too_large), the KnowledgePublishIssueCode values of a publish (such as knowledge_ingestion_pending and retrieval_gate_failed), the one detail of knowledge_base_version_in_use the KnowledgeSourceIssueCode values of a Source (such as source_settings_mismatch), the KnowledgeDocumentIssueCode values of an upload (such as document_too_large), the KnowledgeReviewIssueCode value allow_terms_required, the KnowledgeQueryIssueCode value knowledge_base_no_active_version of a query, the KnowledgeSearchIssueCode value embedding_space_mismatch of the internal search, the KnowledgeEvalQueryIssueCode values of a corpus query (such as eval_query_relevance_missing), the KnowledgeEvaluationIssueCode value knowledge_corpus_empty, the KnowledgeBindingIssueCode values of the Knowledge bindings of an Agent (such as knowledge_base_reference_unknown and knowledge_binding_name_repeated), at /knowledge/<i>/..., knowledge_grant_refused, the one detail of the forbidden that refuses the knowledge grant of an internal search, and owner_or_admin_required, the one detail of the forbidden that refuses the review of a Document, or the read of the held text of a quarantined one, to an API key or to a Member who is not an owner or admin, and from 1.54.0 identifier_pattern_invalid of a Knowledge base draft and embedding_space_mismatch of an ingestion batch and of a query embedding task, and from 1.55.0 the PromptTemplateIssueCode values of a Prompt template draft (such as prompt_template_name_taken), the PromptPublishIssueCode values of a template or Agent version publish (the PromptLintCode lint codes, such as phi_literal and undeclared_reference, and prompt_warning_unacknowledged), the AgentPromptIssueCode values of the prompt of an Agent (such as prompt_template_reference_unknown), at /prompt/..., the one detail of prompt_template_in_use, and prompts_admin_required, the one detail of the forbidden that refuses a write to an Organization layer to a caller without prompts:admin, and from part B of 1.55.0 the PromptEvalSuiteIssueCode value prompt_eval_agent_unknown of an evaluation suite and the PromptEvalScenarioIssueCode values of a scenario (such as prompt_eval_caller_kind_mismatch and prompt_eval_rubric_required), the PromptEvalRunIssueCode values of a suite run (such as prompt_eval_judge_required, and evaluation_engine_not_available, the one detail of the capability_not_available that refuses a run until the headless Engine runs evaluation Calls) and the ConversationTestIssueCode values of a conversation test run (such as conversation_test_suite_other_agent), the ExperimentIssueCode values of an experiment (such as experiment_policy_mismatch and experiment_arm_is_control, and live_call_judging_not_available, the one detail of the capability_not_available that refuses a suite on an experiment), and experiment_conflict, the one detail of that 409, and from 1.56.0 the OutcomeSchemaIssueCode values of the Outcome schema of an Agent (such as outcome_phi_free_text and outcome_rollup_not_enum), at /outcome_schema/..., the AnalyzerBindingIssueCode values of its analyzer bindings (such as analyzer_unknown and analysis_outcomes_without_schema, and analyzer_kind_not_available, the one detail of the capability_not_available that refuses a reserved analyzer), at /analysis/..., and transcript_unavailable, the one detail of that 409.
contact_idContactIdnoOn contact_match_conflict and contact_merge_conflict (1.61.0): one candidate Contact.
current_revisionintegernoOn revision_mismatch: the revision the resource is at now.
experiment_idExperimentIdnoOn experiment_conflict with the reason another_running (1.55.0): the experiment running on the Agent.
layerstringnoOn setting_locked and setting_out_of_bounds (1.18.0): the layer that set the lock or the bound, platform, organization or agent (the value a narrow-only per-Call override may not exceed); on setting_override_not_allowed, call. From 1.24.0 setting_locked with platform also answers an Agent version that sets an Organization-only path, safety.disclosure.required, and from 1.32.0 an Organization layer or an Agent version that sets a platform-only path, a tuning leaf. On setting_not_settable_at_layer (1.42.0): the layer that tried to set the value and may not, platform, organization, agent or call.
limit_scopeLimitScopeno
messagestringyesA human-readable explanation; never parse it.
modelstringnoOn provider_not_allowed (1.10.0) and capability_mismatch (1.17.0): the model id the issue concerns.
node_idstringnoOn a Policy issue (1.47.0): the id of the JDM node the issue concerns, so that a refusal names the node and the code (FR-orchestration-2).
pathstringnoA JSON Pointer to the request field the issue concerns.
providerstringnoOn provider_not_allowed (1.10.0), capability_mismatch (1.17.0), credential_mode_unavailable and credential_invalid (1.28.0): the Provider id the issue concerns; from 1.38.0, with the reason carrier_unpriced, the carrier, such as twilio.
reasonstringnoOn provider_not_allowed (1.10.0): why the reference is refused: provider_disabled, provider_reserved, mock_not_allowed, model_not_allowed, stage_not_served, duplicate or, from 1.12.0, voice_disabled or, from 1.32.0, region_not_allowed (the regions of the Provider are outside those of the Compliance profile) or baa_not_stated (the profile requires a BAA statement the Provider does not make) or, from 1.34.0, byok_fallback_forbidden (the stage started on the Organization's own credential, the Compliance profile forbids the fallback to Vocal's, and this entry would run on Vocal's) or, from 1.38.0, model_unpriced (the model has no vendor list price above 0 in force for every unit of its stage, at publish or at the admission instant, the Organization's own key included) or carrier_unpriced (with the stage telephony: the carrier minute of a phone Call has no vendor list price above 0 in force at the admission instant) or, from 1.60.0, preview_not_opted_in (a preview Provider in a live chain of an Organization whose preview_providers is false) or, from 1.41.0, phi_not_allowed (the Provider processes in the region cn while the Agent version declares a phi variable or model input and output capture is on, at the pointer /variables/<i>/phi or /platform/flags/diagnostics.capture_model_io, at publish and at admission). On capability_mismatch (1.17.0): the descriptor field that does not fit, languages or streaming, or from 1.34.0 voice_model (the voice is not spoken with the model its reference names, as the Provider inventory binds it), or from 1.49.0 tool_calling (the Agent attaches Tools and the model declares no tool calling, at /model, FR-agents-2). On egress_denied (1.49.0): an EgressDenialReason, such as scheme_not_https or forbidden_address. On the one detail of dial_not_allowed (1.22.0), whose code is dial_not_allowed too: a DialRefusalReason, and path is /to for a destination reason or /from_number_id for a Phone number reason when the request named one. On transfer_destination_not_dialable (1.50.0): a DialRefusalReason, country_not_allowed or premium_rate. On the one detail of transfer_refused (1.50.0), whose code is transfer_refused too: a TransferRefusalReason, and path is /destination. On the one detail of last_owner (1.51.0), whose code is last_owner too: a LastOwnerChange. On the one detail of rate_limited (1.51.0), whose code is rate_limited too: the RateLimitTier that refused the request. On the one detail of knowledge_base_version_in_use (1.53.0), whose code is knowledge_base_version_in_use too: a KnowledgeVersionInUseReason, and from 1.54.0 with pinned the agent_id and agent_version that pin it. On the one detail knowledge_grant_refused of a forbidden (1.53.0): a KnowledgeGrantRefusalReason. On retrieval_gate_failed (1.53.0): the KnowledgeGateCheck that failed, one detail each. On knowledge_evaluation_required (1.53.0): a KnowledgeEvaluationRequiredReason. On the one detail of prompt_template_in_use (1.55.0): a PromptTemplateInUseReason, with agent_version the agent_id and agent_version the api found. On prompt_warning_unacknowledged (1.55.0): the PromptLintCode of the warning to acknowledge. On prompt_template_kind_mismatch (1.55.0): a PromptKindMismatchReason. On the one detail of experiment_conflict (1.55.0): an ExperimentConflictReason, with experiment_id for another_running. On experiment_policy_mismatch (1.55.0): an ExperimentMismatchReason, one detail each. On the one detail of transcript_unavailable (1.56.0): a TranscriptUnavailableReason. On the one detail of capture_not_allowed (1.57.0): a CaptureRefusalReason. On the one detail of reveal_grant_conflict (1.57.0): a RevealGrantConflictReason. On the one detail of human_task_conflict (1.62.0): a HumanTaskConflictReason.
run_idPromptEvalRunIdnoOn evaluation_gate_failed (1.63.0): the run of the gating suite whose failed check the detail names, an EvaluationGateReason in reason.
stagestringnoOn provider_not_allowed (1.10.0) and capability_mismatch (1.17.0): the stage, stt, llm or tts; from 1.38.0 telephony on the provider_not_allowed whose reason is carrier_unpriced.