Skip to content

Typed schemas

These are the typed shapes behind agents and skills. Every create-or-update path validates against the matching shape before anything is saved, so the fields, types, and defaults below are exactly what the platform accepts. A field that points at a nested object links to that object’s own table further down.

Agent and skill specs

AgentSpec

The shape an agent is created and validated against. See Agents for what each setting does.

FieldTypeRequiredDefault
namestringYes
slugstringYes
statusstringdraft
charterCharterRef or InlineCharterYes
model_idstring or nullnull
max_loop_iterationsinteger20
max_tokens_per_runinteger100000
autonomy_modestringpropose
default_approver_user_idstring or nullnull
default_approver_group_idstring or nullnull
output_configobject or nullnull
toolsarray of string
capability_bindingsobject
allowed_sourcesarray of string or nullnull
reach_modestringrestricted
triggersarray of TriggerSpec
service_account_rolesarray of string

CharterRef

FieldTypeRequiredDefault
skill_idstringYes

InlineCharter

FieldTypeRequiredDefault
bodystringYes
namestring or nullnull
notesstring or nullnull
required_toolsarray of string or nullnull

TriggerSpec

FieldTypeRequiredDefault
trigger_kindstringmanual
trigger_ref_tablestring or nullnull
trigger_ref_idstring or nullnull
trigger_typestring or nullnull
table_namestring or nullnull
conditionsobject or nullnull
is_defaultbooleanfalse

SkillSpec

The shape of a reusable skill. See Skills and knowledge.

FieldTypeRequiredDefault
namestringYes
bodystring""
kindstringinvocable
surface_idstring or nullnull
applies_to_intentsarray of string
applies_to_toolsarray of string
required_toolsarray of string
priorityinteger100
response_schemaobject or nullnull
notesstring or nullnull
applies_to_tablestring or nullnull
applies_to_capabilitystring or nullnull
note_settingsobject or nullnull