Create an assistant

POST/api/v1/assistants

scope assistants:writeIdempotent

Creates an assistant. targets binds it to the channels it should answer on; a channel already bound to another assistant is refused with 409 conflict and reason: target_taken, because one channel has exactly one assistant.

Body

application/json

Name	Type	Description
`name`required	`string`	Display name
`color`optional	`string \| null`	Accent colour, or null
`enabled`optional	`boolean`	Defaults to true. A disabled assistant refuses every run start
`system_prompt`optional	`string`	Persona and standing instructions
`model`optional	`string \| null`	Model id, or null to inherit
`temperature`optional	`number \| null`	Sampling temperature
`tool_access`optional	`map<string, boolean>`	Per-tool on or off, by tool id from GET /tools
`gated_tools`optional	`string[]`	Tool ids that must raise a human approval first
`schedule`optional	`object`	When it is on duty
`schedule.mode`required	`string (enum)`	When the assistant may answer`alwayscustom_hoursoutside_business_hours`
`schedule.hours`optional	`map<string, string[][]> \| null`	custom_hours only: weekday to [open, close] ranges
`default_handoff_user_id`optional	`string (uuid) \| null`	Member who receives its handoffs
`history_limit`optional	`integer \| null`	Recent messages to send; null for the full history
`transcribe_media`optional	`boolean`	Transcribe voice notes and describe photos
`handle_voice`optional	`boolean`	Send voice notes to the model
`handle_images`optional	`boolean`	Send customer photos to the model
`voice_replies`optional	`boolean`	May reply with a voice note
`voice_provider`optional	`string \| null`	Text-to-speech provider
`voice_id`optional	`string \| null`	Provider-specific voice
`targets`optional	`string[]`	What it answers on: channel names, or pwa:<connection_id> for one linked personal number. Replaces the whole list

Request

curl -X POST "https://your-crm.example.com/api/v1/assistants" \
  -H "Authorization: Bearer $RAABTA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2a9e-3b4d-4c5e-8f7a-9b0c1d2e3f4a" \
  -d '{
    "name": "Front desk",
    "system_prompt": "You are the front desk for Acme Clinic. Book appointments, answer questions about opening hours and prices, and hand off anything clinical to a human.",
    "targets": [
      "whatsapp",
      "webchat"
    ]
  }'

Response · 201 Created

{
  "data": {
    "id": "8f2c1d3e-4a5b-4c6d-9e0f-1a2b3c4d5e6f",
    "name": "Front desk",
    "color": "#0ea5e9",
    "enabled": true,
    "system_prompt": "You are the front desk for Acme Clinic. Book appointments, answer questions about opening hours and prices, and hand off anything clinical to a human.",
    "model": null,
    "temperature": null,
    "tool_access": {
      "contacts.search": true,
      "bookings.create": true
    },
    "gated_tools": [
      "bookings.cancel"
    ],
    "delegation": {
      "enabled": false,
      "allowed_tools": null,
      "max_children_per_run": 3,
      "max_cost_usd": null
    },
    "schedule": {
      "mode": "always"
    },
    "default_handoff_user_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
    "history_limit": 20,
    "transcribe_media": true,
    "handle_voice": true,
    "handle_images": false,
    "voice_replies": false,
    "voice_provider": null,
    "voice_id": null,
    "targets": [
      "whatsapp",
      "webchat"
    ],
    "instruction_count": 3,
    "created_at": "2026-08-01T09:00:00.000Z",
    "updated_at": "2026-09-01T11:30:00.000Z"
  }
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	Assistant id
`name`required	`string`	Display name, shown in the dashboard and the activity feed
`color`required	`string \| null`	Accent colour used in the activity feed
`enabled`required	`boolean`	A disabled assistant refuses every run start
`system_prompt`required	`string`	The persona and standing instructions sent to the model on every tick
`model`required	`string \| null`	Model id, or null to inherit the account default
`temperature`required	`number \| null`	Sampling temperature, or null to inherit the account default
`tool_access`required	`map<string, boolean>`	Per-tool on or off, by tool id. A tool absent here takes the catalogue default from GET /tools
`gated_tools`required	`string[]`	Tool ids that raise a human approval before running, on top of the always-gated critical tools
`delegation`required	`object`	Whether and how far this assistant may delegate
`delegation.enabled`required	`boolean`	May this assistant hand work to sub-agents
`delegation.allowed_tools`required	`string[] \| null`	Tools a sub-agent may be given; null means anything the parent holds, and an empty list means nothing
`delegation.max_children_per_run`required	`integer`	Sub-agents one run may spawn, clamped by the engine
`delegation.max_cost_usd`required	`number \| null`	Tighter spend ceiling for the whole tree; null uses the engine default
`schedule`required	`object`	When this assistant is allowed to answer
`schedule.mode`required	`string (enum)`	always = any hour; outside_business_hours = only when the business is closed; custom_hours = only inside the hours below`alwayscustom_hoursoutside_business_hours`
`schedule.hours`optional	`map<string, string[][]> \| null`	custom_hours only: weekday key to a list of [open, close] times as HH:MM. A missing day is closed
`default_handoff_user_id`required	`string (uuid) \| null`	Member who receives conversations this assistant hands off
`history_limit`required	`integer \| null`	Recent messages sent to the model; null is the full history and 0 is none
`transcribe_media`required	`boolean`	Transcribe inbound voice notes and describe photos for the inbox
`handle_voice`required	`boolean`	Send inbound voice notes to the model
`handle_images`required	`boolean`	Send inbound customer photos to the model
`voice_replies`required	`boolean`	May reply with a synthesised voice note
`voice_provider`required	`string \| null`	Text-to-speech provider, or null for none
`voice_id`required	`string \| null`	Provider-specific voice, or null for its default
`targets`required	`string[]`	What it answers on: a channel name, or pwa:<connection_id> for one linked personal number
`instruction_count`required	`integer`	Instructions bound to this assistant
`created_at`required	`string (date-time)`	When the assistant was created
`updated_at`required	`string (date-time)`	When it was last edited

Errors

Status	Code	When
400	`bad_request`	The request could not be parsed: malformed JSON, an invalid cursor, or a query parameter of the wrong shape.
400	`validation_error`	The body or query failed validation. `details` lists each failing field with a `path` and a `message`.
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
409	`conflict`	The request conflicts with current state: a duplicate phone number on create, an invalid state transition, or an idempotent request that is still in flight.
422	`unprocessable`	The request was well-formed but cannot be carried out. `reason` is a stable string saying why (for example `outside_window` or `stage_not_in_pipeline`).
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.