Scheme

Cele 63 obiecte pe care API-ul le acceptă și le returnează. Formele *Resource sunt ce primești; formele Store*/Update* sunt ce trimiți. O schemă Update* are aceleași câmpuri ca perechea ei Store*, dar niciunul obligatoriu — un PATCH schimbă doar ce numește.

ApiKeyResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
type	string	da
display	string	da
public_key	string | null	da
scopes	object	da
allowed_origins	object	da
allowed_assistant_ids	object	da
allowed_ips	object	da
expires_at	string | null	da
last_used_at	string | null	da
last_used_ip	string | null	da
revoked_at	string | null	da
rotated_from_id	string | null	da
usable	boolean	da
created_at	string | null	da

AssistantFirstMessageMode

Enum de string-uri. Valori acceptate:

assistant_speaks_first · assistant_speaks_first_with_model_generated_message · assistant_waits_for_user

AssistantMode

§29. A realtime (speech-to-speech) assistant has no separate transcriber or voice stage, so the builder hides those tabs and the resolver omits them.

Enum de string-uri. Valori acceptate:

pipeline · realtime

AssistantResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
description	string | null	da
status	string	da
is_published	boolean	da
version	integer	da
current_version_id	string | null	da
published_version_id	string | null	da
has_unpublished_changes	boolean	da
mode	string	da
language	string | null	da
additional_languages	object	da
first_message	string | null	da
first_message_mode	string | null	da
system_prompt	string | null	da
silence_timeout_seconds	integer	da
max_duration_seconds	integer	da
template_strictness	string | null	da
transcriber	object | null	da
model	object | null	da
voice	object | null	da
speech_to_speech_model	object | null	da
start_speaking_plan	object | null	da
stop_speaking_plan	object | null	da
artifact_plan	object | null	da
analysis_plan	object | null	da
observability_plan	object | null	da
message_plan	object | null	da
keypad_input_plan	object | null	da
recording_consent_plan	object | null	da
voicemail_detection_plan	object | null	da
transfer_plan	object | null	da
compliance_plan	object | null	da
background_sound	object | null	da
background_speech_denoising	object | null	da
end_call_phrases	object	da
idle_messages	object	da
background_messages	object	da
pronunciations	object	da
custom_keywords	object	da
voice_formatting	object | null	da
server	object | null	da
hooks	object | null	da
fallbacks	object | null	da
variables	object	da
variable_values	object	da
knowledge_only	boolean	da
knowledge_only_plan	object | null	da
metadata	object	da
tools	ToolAttachmentResource[]	—
knowledge_bases	KnowledgeBaseResource[]	—
created_at	string | null	da
updated_at	string | null	da
last_published_at	string | null	da

AssistantTemplateStrictness

§128. An undefined variable silently rendering as an empty string is how a prompt becomes "Hello , your appointment on is confirmed" in production. The tenant chooses which failure they prefer. | | |---| | lenient <br/> Render an empty string. Fast, and wrong quietly. | | warn <br/> Render the placeholder untouched and log a warning — the default. | | strict <br/> Throw. The call setup fails loudly instead of shipping a broken prompt. |

Enum de string-uri. Valori acceptate:

lenient · warn · strict

AssistantVersionResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
assistant_id	string	da
version	integer	da
label	any	da
change_summary	string | null	da
config_hash	string	da
config	object	—	The full snapshot is large; it is returned only when the caller asked for this specific version, not in a listing.
tool_refs	object	da
knowledge_base_refs	object	da
published_at	string | null	da

CustomerResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
display_name	string | null	da
name	string | null	da
first_name	string | null	da
last_name	string | null	da
company	string | null	da
locale	string | null	da
timezone	string | null	da
source	string	da	§126: which system owns this record.
external_id	string | null	da
externally_owned	boolean	da
do_not_contact	boolean	da
conversation_count	integer	da
first_seen_at	string | null	da
last_seen_at	string | null	da
merged_into_customer_id	string | null	da
metadata	object | null	da
notes	string | null	da
created_at	string | null	da
identifiers	object[]	—
attributes	string | integer | number | boolean | object[]	—
conversations	object[]	—

InboundRoute

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
name	string	da
description	string | null	da
enabled	boolean	da
priority	integer	da
phone_number_id	string | null	da
sip_trunk_id	string | null	da
did_pattern	string | null	da
did_match_type	string	da
caller_pattern	string | null	da
caller_match_type	string	da
source_ip_acl	object | null	da
time_condition_id	string | null	da
destination_type	assistant · squad · queue · ivr · ring_group · extension …	da	Where an inbound call goes once the tenant has been resolved (§10, §66). Deliberately a string enum plus a nullable ULID rather than a real polymorphic relation: the target tables (assistants, queues, ivrs, ring_groups, extensions) are owned by four different agents and land in four different migration ranges, so a hard foreign key here would force a build order that does not exist.
destination_id	string | null	da
destination_value	string | null	da
fallback_destination_type	assistant · squad · queue · ivr · ring_group · extension … | null	da
fallback_destination_id	string | null	da
fallback_destination_value	string | null	da
recording_mode	disabled · mono · dual_channel · inherit	da	§51. dual_channel is what makes speaker-attributed transcripts and accurate talk-over metrics possible, so it is preferred wherever the carrier offers it.
ring_timeout_seconds	integer	da
screen_caller	boolean	da
set_variables	object | null	da
metadata	object | null	da
created_at	string | null	da	date-time
updated_at	string | null	da	date-time
deleted_at	string | null	da	date-time

IntegrationConnectionResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
integration	string	da
name	string	da
status	string	da
active	boolean	da
config	object | null	da	Config is non-secret by construction; secrets live in the credential row.
granted_capabilities	object	da
auth	oauth2 · api_key · none	da
connected_at	string | null	da
last_tested_at	string | null	da
last_test_status	string | null	da
last_synced_at	string | null	da
last_error	string | null	da
created_at	string | null	da

KnowledgeBaseResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
description	string | null	da
provider	string | null	da
namespace	string | null	da
embedding	object	da
embedding.provider	string	da
embedding.model	string	da
embedding.dimensions	integer	da
chunk_size	integer	da
chunk_overlap	integer	da
retrieval	object	da
custom_provider	object | null	da
knowledge_only	boolean	da
knowledge_only_plan	object | null	da
status	string	da
document_count	integer	da
chunk_count	integer	da
total_bytes	integer	da
metadata	object	da
documents	KnowledgeDocumentResource[]	—
created_at	string | null	da
updated_at	string | null	da

KnowledgeDocumentResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
knowledge_base_id	string	da
title	string	da
source_type	string | null	da
source_url	string | null	da
mime_type	string | null	da
extension	string | null	da
size_bytes	integer	da
status	string | null	da
progress	integer	da
failure_code	string | null	da
failure_reason	string | null	da
extracted_chars	integer	da
chunk_count	integer	da
token_count	integer	da
language	string | null	da
metadata	object	da
ingested_at	string | null	da
created_at	string | null	da

KnowledgeProvider

§41. pgvector is the only one implemented; the rest exist so the retriever interface is shaped for them and the UI can say "coming soon" honestly instead of silently doing nothing (§188).

Enum de string-uri. Valori acceptate:

pgvector · custom · qdrant · pinecone · weaviate

KnowledgeQueryRequest

Câmp	Tip	Obligatoriu	Note
query	string	da	max 4000 chars. min 1 chars
top_k	integer | null	—	min 1. max 50
threshold	number | null	—	min 0. max 1
namespace	string | null	—	max 255 chars
metadata_filters	string[] | null	—

McpCachedToolResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
mcp_server_id	string	da
name	string	da
title	string | null	da
description	string | null	da
input_schema	object | null	da
output_schema	object | null	da
annotations	object	da
risk_level	string | null	da
requires_confirmation	boolean	da
enabled	boolean	da
disabled_reason	string | null	da
discovered_at	string | null	da
expires_at	string | null	da

McpConfirmationPolicy

§37. Optional confirmation before a tool call actually executes.

Enum de string-uri. Valori acceptate:

never · destructive · always

McpRiskLevel

§37. Ordered by blast radius — atLeast() is what the confirmation policy and the per-organization block list are expressed in.

Enum de string-uri. Valori acceptate:

read · write · destructive · financial · privileged

McpServerResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
description	string | null	da
url	string | null	da
transport	string | null	da
auth_type	string	da
headers	object	da
secret_keys	object	da
provider_credential_id	string | null	da
oauth_connection_id	string | null	da
tool_policy	string | null	da
allowed_tools	object	da
denied_tools	object	da
tool_risk_overrides	object	da
blocked_risk_levels	object	da
default_risk_level	string | null	da
confirmation_policy	string | null	da
timeout_seconds	integer	da
cache_ttl_seconds	integer	da
active	boolean	da
status	string | null	da
status_message	string | null	da
protocol_version	string | null	da
server_info	object | null	da
capabilities	object | null	da
tool_count	integer	da
last_discovery_at	string | null	da
last_health_check_at	string | null	da
tools	McpCachedToolResource[]	—
created_at	string | null	da

McpToolPolicy

§37.

Enum de string-uri. Valori acceptate:

allow_all · allow_selected · deny_selected

McpTransport

Enum de string-uri. Valori acceptate:

streamable_http · sse · stdio

OutboundRoute

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
name	string	da
description	string | null	da
enabled	boolean	da
priority	integer	da
destination_pattern	string | null	da
match_type	string	da
countries	object | null	da
min_digits	integer | null	da
max_digits	integer | null	da
emergency	boolean	da
sip_trunk_id	string | null	da
phone_number_id	string | null	da
failover_sip_trunk_id	string | null	da
strip_digits	integer	da
prepend_digits	string | null	da
caller_id_number	string | null	da
caller_id_name	string | null	da
blocked	boolean	da
block_reason	string | null	da
max_call_seconds	integer | null	da
rate_per_minute	string | null	da
high_cost	boolean	da
set_variables	object | null	da
metadata	object | null	da
created_at	string | null	da	date-time
updated_at	string | null	da	date-time
deleted_at	string | null	da	date-time

PhoneNumber

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
number	string	da
friendly_name	string | null	da
provider	twilio · telnyx · didww · plivo · zadarma · didlogic …	da	§8.1. The telephony providers CallAgent can terminate or originate through. The value is what is stored in phone_numbers.provider, sip_trunks.provider and provider_credentials.provider — keep them stable, they are persisted.
telephony_account_id	string | null	da
provider_credential_id	string | null	da
provider_number_sid	string | null	da
provider_account_sid	string | null	da
provider_metadata	object | null	da
capabilities	object | null	da
country	string | null	da
region	string | null	da
locality	string | null	da
number_type	string | null	da
address_requirement	string | null	da
destination_type	assistant · squad · queue · ivr · ring_group · extension … | null	da
destination_id	string | null	da
destination_value	string | null	da
fallback_destination_id	string | null	da
fallback_destination_type	assistant · squad · queue · ivr · ring_group · extension … | null	da
assistant_id	string | null	da
squad_id	string | null	da
hook_enabled	boolean	da
hook_url	string | null	da
hook_timeout_ms	integer	da
hook_headers	object | null	da
hook_fallback	string	da
hook_last_success_at	string | null	da	date-time
hook_last_failure_at	string | null	da	date-time
hook_last_error	string | null	da
outbound_enabled	boolean	da
outbound_caller_id_number	string | null	da
outbound_caller_id_name	string | null	da
sip_trunk_id	string | null	da
caller_id_policy_id	string | null	da
sms_enabled	boolean	da
sms_assistant_id	string | null	da
sms_webhook_url	string | null	da
messaging_service_sid	string | null	da
recording_mode	disabled · mono · dual_channel · inherit	da	§51. dual_channel is what makes speaker-attributed transcripts and accurate talk-over metrics possible, so it is preferred wherever the carrier offers it.
recording_consent_required	boolean	da
voice_webhook_url	string | null	da
status_webhook_url	string | null	da
webhooks_configured_at	string | null	da	date-time
webhooks_in_sync	boolean	da
max_concurrent_calls	integer | null	da
status	pending · active · suspended · released · error	da
inbound_enabled	boolean	da
imported_at	string | null	da	date-time
purchased_at	string | null	da	date-time
released_at	string | null	da	date-time
last_inbound_at	string | null	da	date-time
last_outbound_at	string | null	da	date-time
monthly_cost	string | null	da
setup_cost	string | null	da
currency	string	da
notes	string | null	da
settings	object | null	da
metadata	object | null	da
created_at	string | null	da	date-time
updated_at	string | null	da	date-time
deleted_at	string | null	da	date-time
phone_number_hook_id	string | null	da

PhoneNumberStatus

Enum de string-uri. Valori acceptate:

pending · active · suspended · released · error

ProviderCredentialResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
class	string	da
provider	string	da
name	string	da
description	string | null	da
config	object | null	da
secret_keys	object	da
is_default	boolean	da
active	boolean	da
validation_status	string	da
validated_at	string | null	da
validation_error	string | null	da
capabilities	object | null	da
expires_at	string | null	da
rotated_at	string | null	da
created_at	string | null	da

SipAuthMode

Enum de string-uri. Valori acceptate:

credentials · ip · both

SipDiagnostic

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
sip_trunk_id	string | null	da
sip_trunk_gateway_id	string | null	da
kind	string	da
outcome	string	da
response_code	integer | null	da
response_reason	string | null	da
latency_ms	integer | null	da
target	string | null	da
request_trace	string | null	da
response_trace	string | null	da
message	string | null	da
context	object | null	da
triggered_by_user_id	string | null	da
created_at	string	da	date-time

SipDid

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
sip_trunk_id	string	da
number	string | null	da
pattern	string | null	da
match_type	string	da
priority	integer	da
label	string | null	da
country	string | null	da
phone_number_id	string | null	da
destination_type	assistant · squad · queue · ivr · ring_group · extension … | null	da
destination_id	string | null	da
destination_value	string | null	da
enabled	boolean	da
metadata	object | null	da
created_at	string | null	da	date-time
updated_at	string | null	da	date-time

SipDtmfMode

§49. rfc2833 (a.k.a. RFC 4733) is the default because it survives transcoding; inband breaks under any lossy codec; info is a signalling-path fallback for carriers that strip telephone-event.

Enum de string-uri. Valori acceptate:

rfc2833 · inband · info

SipLeadingPlus

§8.4 "leading plus behavior". Carriers disagree violently about whether an outbound Request-URI user should be +4917612345678, 4917612345678 or 004917612345678, and getting it wrong is the single most common reason a new trunk returns 404 on every call.

Enum de string-uri. Valori acceptate:

keep · strip · add · international_prefix

SipSrtpPolicy

Enum de string-uri. Valori acceptate:

disabled · optional · required

SipTransport

Enum de string-uri. Valori acceptate:

udp · tcp · tls

SipTrunk

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
name	string	da
slug	string	da
description	string | null	da
provider	twilio · telnyx · didww · plivo · zadarma · didlogic …	da	§8.1. The telephony providers CallAgent can terminate or originate through. The value is what is stored in phone_numbers.provider, sip_trunks.provider and provider_credentials.provider — keep them stable, they are persisted.
telephony_account_id	string | null	da
provider_credential_id	string | null	da
direction	inbound · outbound · both	da
enabled	boolean	da
auth_mode	credentials · ip · both	da
username	string | null	da
auth_username	string | null	da
realm	string | null	da
from_user	string | null	da
from_domain	string | null	da
proxy	string | null	da
outbound_proxy	string | null	da
contact_host	string | null	da
register	boolean	da
register_expiry_seconds	integer	da
register_transport	udp · tcp · tls | null	da
register_proxy	string | null	da
register_on_startup	boolean	da
retry_seconds	integer	da
registered_at	string | null	da	date-time
registration_expires_at	string | null	da	date-time
transport	udp · tcp · tls	da
srtp_policy	disabled · optional · required	da
verify_tls_peer	boolean	da
tls_sni	string | null	da
tls_version	string | null	da
codecs	object | null	da
dtmf_mode	rfc2833 · inband · info	da	§49. rfc2833 (a.k.a. RFC 4733) is the default because it survives transcoding; inband breaks under any lossy codec; info is a signalling-path fallback for carriers that strip telephone-event.
dtmf_duration_ms	integer	da
inter_digit_delay_ms	integer	da
ptime_ms	integer | null	da
bypass_media	boolean	da
late_negotiation	boolean	da
comfort_noise	boolean	da
options_ping_enabled	boolean	da
options_ping_seconds	integer	da
keepalive_seconds	integer	da
nat_keepalive	boolean	da
status	unknown · up · down · registering · failed · disabled	da
status_checked_at	string | null	da	date-time
last_response_code	integer | null	da
last_latency_ms	integer | null	da
last_error	string | null	da
consecutive_failures	integer	da
inbound_source_acl	object | null	da
inbound_require_acl	boolean	da
inbound_did_source	string	da
inbound_did_header	string | null	da
inbound_caller_id_source	string	da
inbound_strip_plus	boolean	da
inbound_number_prefix	string | null	da
inbound_strip_digits	integer	da
inbound_destination_type	assistant · squad · queue · ivr · ring_group · extension … | null	da
inbound_destination_id	string | null	da
inbound_destination_value	string | null	da
outbound_caller_id_number	string | null	da
outbound_caller_id_name	string | null	da
outbound_caller_id_privacy	boolean	da
leading_plus	keep · strip · add · international_prefix	da	§8.4 "leading plus behavior". Carriers disagree violently about whether an outbound Request-URI user should be +4917612345678, 4917612345678 or 004917612345678, and getting it wrong is the single most common reason a new trunk returns 404 on every call.
international_prefix	string	da
outbound_prefix	string | null	da
outbound_strip_digits	integer	da
sip_uri_template	string | null	da
allow_sip_uri_dialing	boolean	da
custom_sip_headers	object | null	da
outbound_channel_variables	object | null	da
supports_refer	boolean	da
supports_sip_info	boolean	da
supports_sip_message	boolean	da
supports_sip_notify	boolean	da
follow_302_redirects	boolean	da
send_pai	boolean	da
send_rpid	boolean	da
send_diversion_on_transfer	boolean	da
max_concurrent_calls	integer | null	da
max_calls_per_second	integer | null	da
sofia_profile	string	da
gateway_name	string | null	da
generated_config	string | null	da
generated_config_hash	string | null	da
config_applied_at	string | null	da	date-time
settings	object | null	da
metadata	object | null	da
created_at	string | null	da	date-time
updated_at	string | null	da	date-time
deleted_at	string | null	da	date-time

SipTrunkDirection

Enum de string-uri. Valori acceptate:

inbound · outbound · both

SipTrunkGateway

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
sip_trunk_id	string	da
name	string	da
host	string	da
port	integer	da
transport	udp · tcp · tls | null	da
priority	integer	da
weight	integer	da
enabled	boolean	da
failover_only	boolean	da
max_concurrent_calls	integer | null	da
username	string | null	da
realm	string | null	da
outbound_proxy	string | null	da
register	boolean	da
status	unknown · up · down · registering · failed · disabled	da
status_checked_at	string | null	da	date-time
last_response_code	integer | null	da
last_latency_ms	integer | null	da
last_error	string | null	da
consecutive_failures	integer	da
metadata	object | null	da
created_at	string | null	da	date-time
updated_at	string | null	da	date-time

SipTrunkStatus

Enum de string-uri. Valori acceptate:

unknown · up · down · registering · failed · disabled

SquadDestinationType

§45.

Enum de string-uri. Valori acceptate:

assistant · squad · human_queue · dynamic · end

SquadHandoffContextMode

§46. How much of the conversation the receiving assistant inherits.

Enum de string-uri. Valori acceptate:

all_messages · last_n · user_only · user_assistant · summary · none

SquadResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
description	string | null	da
status	string | null	da
is_published	boolean	da
version	integer	da
current_version_id	string | null	da
entry_assistant_id	string | null	da
handoff_context_mode	string | null	da
handoff_context_size	integer	da
handoff_extract_variables	object	da
silent_handoff	boolean	da
handoff_message	string | null	da
metadata	object	da
members	object[]	—
routes	object[]	—
created_at	string | null	da
updated_at	string | null	da

SquadRouteTrigger

§45.

Enum de string-uri. Valori acceptate:

tool · intent · variable · condition · always

StoreAssistantRequest

Câmp	Tip	Obligatoriu	Note
name	string	da	max 255 chars
description	string | null	—	max 255 chars
mode	pipeline · realtime | null	—
language	string | null	—	max 16 chars
additional_languages	string[] | null	—
first_message	string | null	—	max 5000 chars
first_message_mode	assistant_speaks_first · assistant_speaks_first_with_model_generated_message · assistant_waits_for_user | null	—
system_prompt	string | null	—	max 100000 chars
template_strictness	lenient · warn · strict | null	—
silence_timeout_seconds	integer | null	—	min 1. max 600
max_duration_seconds	integer | null	—	min 10. max 3600
transcriber	object	—
transcriber.provider	string | null	—	max 48 chars
model	object	—
model.provider	string | null	—	max 48 chars
model.model	string | null	—	max 96 chars
voice	object	—
voice.provider	string | null	—	max 48 chars
speech_to_speech_model	string[] | null	—
start_speaking_plan	string[] | null	—
stop_speaking_plan	string[] | null	—
artifact_plan	string[] | null	—
analysis_plan	string[] | null	—
observability_plan	string[] | null	—
message_plan	string[] | null	—
keypad_input_plan	string[] | null	—
recording_consent_plan	string[] | null	—
voicemail_detection_plan	string[] | null	—
transfer_plan	string[] | null	—
compliance_plan	string[] | null	—
background_sound	string[] | null	—
background_speech_denoising	string[] | null	—
server	object	—
server.url	string | null	—	uri. max 2048 chars
hooks	string[] | null	—
fallbacks	string[] | null	—
end_call_phrases	string[] | null	—
idle_messages	string[] | null	—
background_messages	string[] | null	—
pronunciations	string[] | null	—
custom_keywords	string[] | null	—
voice_formatting	string[] | null	—
variables	object[] | null	—
variable_values	string[] | null	—
knowledge_only	boolean | null	—
knowledge_only_plan	string[] | null	—
metadata	string[] | null	—
tools	object[] | null	—	Tenancy: exists is scoped by hand because the global Eloquent scope does not apply to the validator's own query.
tool_ids	string[] | null	—
knowledge_base_ids	string[] | null	—
structured_output_ids	string[] | null	—

StoreKnowledgeBaseRequest

Câmp	Tip	Obligatoriu	Note
name	string	da	max 255 chars
description	string | null	—	max 255 chars
provider	pgvector · custom · qdrant · pinecone · weaviate | null	—
namespace	string | null	—	max 255 chars
embedding_provider	string | null	—	max 48 chars
embedding_model	string | null	—	max 96 chars
chunk_size	integer | null	—	min 64. max 4000
chunk_overlap	integer | null	—	min 0. max 2000
retrieval	object	—
retrieval.top_k	integer | null	—	min 1. max 50
retrieval.threshold	number | null	—	min 0. max 1
retrieval.vector_weight	number | null	—	min 0. max 1
retrieval.lexical_weight	number | null	—	min 0. max 1
retrieval.max_context_chars	integer | null	—	min 200. max 100000
retrieval.citations	inline · footnote · none · null | null	—
retrieval.metadata_filters	string[] | null	—
custom_provider	object	—
custom_provider.url	string | null	—	uri. max 2048 chars
custom_provider.headers	string[] | null	—
custom_provider.timeout_seconds	integer | null	—	min 1. max 60
knowledge_only	boolean | null	—
knowledge_only_plan	string[] | null	—
metadata	string[] | null	—

StoreKnowledgeDocumentRequest

Câmp	Tip	Obligatoriu	Note
source_type	file · url · text	da
title	string | null	—	max 255 chars
file	string	—	The extension list is the one the extractor genuinely handles — accepting a PDF we cannot parse would be a silent ingestion of nothing (§188).. binary
url	string | null	—	uri. max 2048 chars
text	string | null	—	max 2000000 chars
metadata	string[] | null	—

StoreMcpServerRequest

Câmp	Tip	Obligatoriu	Note
name	string	da	max 255 chars
description	string | null	—	max 255 chars
transport	streamable_http · sse · stdio	da
url	string | null	—	uri. max 2048 chars
stdio_config	string[] | null	—
auth_type	none · static_headers · bearer · oauth · credential · null | null	—
headers	string[] | null	—
bearer_token	string | null	—	Secrets arrive as their own field and are encrypted before storage; they are never echoed back by the resource.. max 4096 chars
provider_credential_id	string | null	—
oauth_connection_id	string | null	—
tool_policy	allow_all · allow_selected · deny_selected | null	—
allowed_tools	string[] | null	—
denied_tools	string[] | null	—
tool_risk_overrides	string[] | null	—
blocked_risk_levels	read · write · destructive · financial · privileged[] | null	—
default_risk_level	read · write · destructive · financial · privileged | null	—
confirmation_policy	never · destructive · always | null	—
timeout_seconds	integer | null	—	min 1. max 120
cache_ttl_seconds	integer | null	—	min 60. max 86400
active	boolean | null	—
metadata	string[] | null	—

StoreSquadRequest

Câmp	Tip	Obligatoriu	Note
name	string	da	max 255 chars
description	string | null	—	max 255 chars
entry_assistant_id	string | null	—
handoff_context_mode	all_messages · last_n · user_only · user_assistant · summary · none | null	—
handoff_context_size	integer | null	—	min 1. max 200
handoff_extract_variables	string[] | null	—
silent_handoff	boolean | null	—
handoff_message	string | null	—	max 2000 chars
metadata	string[] | null	—
members	object[] | null	—
routes	object[] | null	—

StoreStructuredOutputRequest

Câmp	Tip	Obligatoriu	Note
name	string	da	max 255 chars
key	string | null	—	max 96 chars
description	string | null	—	max 2000 chars
template	summary · sentiment · success · follow_up · lead_qualification · customer_fields … | null	—
target	call · chat · both · null | null	—
schema	string[]	da	min 1 items
prompt	string | null	—	max 20000 chars
model	string[] | null	—
enabled	boolean | null	—
metadata	string[] | null	—

StoreToolRequest

Câmp	Tip	Obligatoriu	Note
name	string	da	max 255 chars
key	string | null	—	max 96 chars. pattern ^[a-zA-Z_][a-zA-Z0-9_]*$
description	string	da	max 2000 chars
type	api_request · function · transfer_call · handoff · end_call · sms …	da	§32. The type drives everything downstream: which form fields the builder shows, which validator runs, and whether the Voice Gateway executes the tool in-process, over HTTP, or in an isolated sandbox worker.
parameters_schema	string[] | null	—
config	string[] | null	—
messages	string[] | null	—
rejection_plan	string[] | null	—
server	string[] | null	—
is_async	boolean | null	—
timeout_seconds	integer | null	—	min 1. max 120
requires_confirmation	boolean | null	—
risk_level	read · write · destructive · financial · privileged | null	—
metadata	string[] | null	—

StructuredOutputResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
key	string	da
description	string | null	da
template	string | null	da
target	string	da
schema	object	da
prompt	string | null	da
model	object | null	da
status	string | null	da
is_published	boolean	da
version	integer	da
current_version_id	string | null	da
enabled	boolean	da
metadata	object	da
created_at	string | null	da
updated_at	string | null	da

TelephonyAccount

Câmp	Tip	Obligatoriu	Note
id	string	da
organization_id	string	da
provider	twilio · telnyx · didww · plivo · zadarma · didlogic …	da	§8.1. The telephony providers CallAgent can terminate or originate through. The value is what is stored in phone_numbers.provider, sip_trunks.provider and provider_credentials.provider — keep them stable, they are persisted.
name	string	da
description	string | null	da
provider_credential_id	string | null	da
external_account_id	string | null	da
external_account_label	string | null	da
is_subaccount	boolean	da
parent_external_account_id	string | null	da
voice_webhook_url	string | null	da
status_webhook_url	string | null	da
sms_webhook_url	string | null	da
is_default	boolean	da
active	boolean	da
health_status	string	da
health_checked_at	string | null	da	date-time
health_message	string | null	da
numbers_synced_at	string | null	da	date-time
numbers_count	integer	da
capabilities	object | null	da
settings	object | null	da
metadata	object | null	da
created_at	string | null	da	date-time
updated_at	string | null	da	date-time
deleted_at	string | null	da	date-time

TelephonyDestinationType

Where an inbound call goes once the tenant has been resolved (§10, §66). Deliberately a string enum plus a nullable ULID rather than a real polymorphic relation: the target tables (assistants, queues, ivrs, ring_groups, extensions) are owned by four different agents and land in four different migration ranges, so a hard foreign key here would force a build order that does not exist.

Enum de string-uri. Valori acceptate:

assistant · squad · queue · ivr · ring_group · extension · voicemail · external · sip_uri · hook

TelephonyProviderId

§8.1. The telephony providers CallAgent can terminate or originate through. The value is what is stored in phone_numbers.provider, sip_trunks.provider and provider_credentials.provider — keep them stable, they are persisted.

Enum de string-uri. Valori acceptate:

twilio · telnyx · didww · plivo · zadarma · didlogic · chime · byo_sip · custom_sip

TelephonyRecordingMode

§51. dual_channel is what makes speaker-attributed transcripts and accurate talk-over metrics possible, so it is preferred wherever the carrier offers it.

Enum de string-uri. Valori acceptate:

disabled · mono · dual_channel · inherit

ToolAttachmentResource

Câmp	Tip	Obligatoriu	Note
id	string	da
name	string	da
key	string	da
type	string | null	da
pin_mode	string | null	da
tool_version_id	string | null	da
alias	string | null	da
enabled	boolean	da
sort_order	integer | null	da

ToolPinMode

§109. "latest" resolves at publish time, not at call time — otherwise editing a tool would silently change the behaviour of an already-published assistant.

Enum de string-uri. Valori acceptate:

latest · pinned

ToolResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
key	string	da
description	string | null	da
type	string | null	da
status	string | null	da
is_published	boolean	da
version	integer	da
current_version_id	string | null	da
parameters_schema	object | null	da
config	object | null	da
messages	object | null	da
rejection_plan	object | null	da
server	object | null	da
is_async	boolean	da
timeout_seconds	integer	da
requires_confirmation	boolean	da
risk_level	string | null	da
mcp_server_id	string | null	da
mcp_tool_name	string | null	da
metadata	object	da
created_at	string | null	da
updated_at	string | null	da

ToolType

§32. The type drives everything downstream: which form fields the builder shows, which validator runs, and whether the Voice Gateway executes the tool in-process, over HTTP, or in an isolated sandbox worker.

Enum de string-uri. Valori acceptate:

api_request · function · transfer_call · handoff · end_call · sms · dtmf · voicemail · sip_request · query · knowledge_base · mcp · google_calendar_create_event · google_calendar_availability · google_sheets_append_row · slack_send_message · gohighlevel_availability · gohighlevel_event_create · gohighlevel_contact_create · gohighlevel_contact_get · bash · computer · text_editor · client_side · custom_provider

ToolVersionResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
tool_id	string	da
version	integer	da
name	string	da
key	string	da
type	string | null	da
description	string | null	da
parameters_schema	object | null	da
config	object | null	da
config_hash	string	da
change_summary	string | null	da
published_at	string | null	da

UpdateAssistantRequest

Câmp	Tip	Note
name	string	max 255 chars
description	string | null	max 255 chars
mode	pipeline · realtime | null
language	string | null	max 16 chars
additional_languages	string[] | null
first_message	string | null	max 5000 chars
first_message_mode	assistant_speaks_first · assistant_speaks_first_with_model_generated_message · assistant_waits_for_user | null
system_prompt	string | null	max 100000 chars
template_strictness	lenient · warn · strict | null
silence_timeout_seconds	integer | null	min 1. max 600
max_duration_seconds	integer | null	min 10. max 3600
transcriber	object
transcriber.provider	string | null	max 48 chars
model	object
model.provider	string | null	max 48 chars
model.model	string | null	max 96 chars
voice	object
voice.provider	string | null	max 48 chars
speech_to_speech_model	string[] | null
start_speaking_plan	string[] | null
stop_speaking_plan	string[] | null
artifact_plan	string[] | null
analysis_plan	string[] | null
observability_plan	string[] | null
message_plan	string[] | null
keypad_input_plan	string[] | null
recording_consent_plan	string[] | null
voicemail_detection_plan	string[] | null
transfer_plan	string[] | null
compliance_plan	string[] | null
background_sound	string[] | null
background_speech_denoising	string[] | null
server	object
server.url	string | null	uri. max 2048 chars
hooks	string[] | null
fallbacks	string[] | null
end_call_phrases	string[] | null
idle_messages	string[] | null
background_messages	string[] | null
pronunciations	string[] | null
custom_keywords	string[] | null
voice_formatting	string[] | null
variables	object[] | null
variable_values	string[] | null
knowledge_only	boolean | null
knowledge_only_plan	string[] | null
metadata	string[] | null
tools	object[] | null	Tenancy: exists is scoped by hand because the global Eloquent scope does not apply to the validator's own query.
tool_ids	string[] | null
knowledge_base_ids	string[] | null
structured_output_ids	string[] | null

UpdateKnowledgeBaseRequest

Câmp	Tip	Note
name	string	max 255 chars
description	string | null	max 255 chars
provider	pgvector · custom · qdrant · pinecone · weaviate | null
namespace	string | null	max 255 chars
embedding_provider	string | null	max 48 chars
embedding_model	string | null	max 96 chars
chunk_size	integer | null	min 64. max 4000
chunk_overlap	integer | null	min 0. max 2000
retrieval	object
retrieval.top_k	integer | null	min 1. max 50
retrieval.threshold	number | null	min 0. max 1
retrieval.vector_weight	number | null	min 0. max 1
retrieval.lexical_weight	number | null	min 0. max 1
retrieval.max_context_chars	integer | null	min 200. max 100000
retrieval.citations	inline · footnote · none · null | null
retrieval.metadata_filters	string[] | null
custom_provider	object
custom_provider.url	string | null	uri. max 2048 chars
custom_provider.headers	string[] | null
custom_provider.timeout_seconds	integer | null	min 1. max 60
knowledge_only	boolean | null
knowledge_only_plan	string[] | null
metadata	string[] | null

UpdateMcpServerRequest

Câmp	Tip	Note
name	string	max 255 chars
description	string | null	max 255 chars
transport	streamable_http · sse · stdio
url	string | null	uri. max 2048 chars
stdio_config	string[] | null
auth_type	none · static_headers · bearer · oauth · credential · null | null
headers	string[] | null
bearer_token	string | null	Secrets arrive as their own field and are encrypted before storage; they are never echoed back by the resource.. max 4096 chars
provider_credential_id	string | null
oauth_connection_id	string | null
tool_policy	allow_all · allow_selected · deny_selected | null
allowed_tools	string[] | null
denied_tools	string[] | null
tool_risk_overrides	string[] | null
blocked_risk_levels	read · write · destructive · financial · privileged[] | null
default_risk_level	read · write · destructive · financial · privileged | null
confirmation_policy	never · destructive · always | null
timeout_seconds	integer | null	min 1. max 120
cache_ttl_seconds	integer | null	min 60. max 86400
active	boolean | null
metadata	string[] | null

UpdateSquadRequest

Câmp	Tip	Note
name	string	max 255 chars
description	string | null	max 255 chars
entry_assistant_id	string | null
handoff_context_mode	all_messages · last_n · user_only · user_assistant · summary · none | null
handoff_context_size	integer | null	min 1. max 200
handoff_extract_variables	string[] | null
silent_handoff	boolean | null
handoff_message	string | null	max 2000 chars
metadata	string[] | null
members	object[] | null
routes	object[] | null

UpdateStructuredOutputRequest

Câmp	Tip	Note
name	string	max 255 chars
key	string | null	max 96 chars
description	string | null	max 2000 chars
template	summary · sentiment · success · follow_up · lead_qualification · customer_fields … | null
target	call · chat · both · null | null
schema	string[]
prompt	string | null	max 20000 chars
model	string[] | null
enabled	boolean | null
metadata	string[] | null

UpdateToolRequest

Câmp	Tip	Note
name	string	max 255 chars
key	string | null	max 96 chars. pattern ^[a-zA-Z_][a-zA-Z0-9_]*$
description	string	max 2000 chars
type	api_request · function · transfer_call · handoff · end_call · sms …	§32. The type drives everything downstream: which form fields the builder shows, which validator runs, and whether the Voice Gateway executes the tool in-process, over HTTP, or in an isolated sandbox worker.
parameters_schema	string[] | null
config	string[] | null
messages	string[] | null
rejection_plan	string[] | null
server	string[] | null
is_async	boolean | null
timeout_seconds	integer | null	min 1. max 120
requires_confirmation	boolean | null
risk_level	read · write · destructive · financial · privileged | null
metadata	string[] | null

WebhookDeliveryResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
webhook_endpoint_id	string	da
event_id	string	da
event_type	string	da
status	string	da
attempts	integer	da
max_attempts	integer	da
response_status	integer | null	da
duration_ms	integer | null	da
error	string | null	da
call_id	string | null	da
assistant_id	string | null	da
next_attempt_at	string | null	da
delivered_at	string | null	da
failed_at	string | null	da
redelivery_of_id	string | null	da
created_at	string | null	da
payload	object	da	The captured exchange is already redacted at write time; this is the §65 delivery log the customer inspects.
request_headers	object | null	da
response_headers	object | null	da
response_body	string | null	da
attempt_log	object[]	—

WebhookEndpointResource

Câmp	Tip	Obligatoriu	Note
id	string	da
object	string	da
name	string	da
url	string	da
description	string | null	da
events	object	da
assistant_ids	object	da
headers	object | null	da
active	boolean	da
status	string	da
consecutive_failures	integer	da
max_attempts	integer	da
timeout_seconds	integer	da
api_version	string	da
secret_rotated_at	string | null	da
secret_overlap_until	string | null	da
last_success_at	string | null	da
last_failure_at	string | null	da
disabled_reason	string | null	da
created_at	string | null	da
updated_at	string | null	da