Create a voice agent

POSThttps://api.norreach.app/v1/voice-agents

Creates an agent for the AI caller — name, language, first message, script (your own words), a voice (GET /voices) and a number (GET /phone-numbers) — as the app's agent editor saves it. It starts unpublished; publishing it to the AI caller is done in the app. Owners, admins and managers. dry_run=true answers it as it would be saved.

⚠ voice:writeRole must allow: voice.agentsSupports dry_runOperation id: create_voice_agent

POST/voice-agents

curl -X POST "https://api.norreach.app/v1/voice-agents" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Nora — staffing",
  "language": "sv",
  "first_message": "Hej, det är Nora från Example Care.",
  "script": "You call nurses who asked about shifts…"
}'

Create a voice agent

{
  "id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "object": "voice_agent",
  "name": "Nora — staffing",
  "description": "Books intro calls",
  "language": "sv",
  "first_message": "Hej, det är Nora från Example Care.",
  "script": "You call nurses who asked about shifts…",
  "voice_preset_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "phone_number_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "published": false,
  "created_at": "2026-10-01T08:00:00.000Z",
  "updated_at": "2026-11-05T08:00:00.000Z"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope voice:write. API keys and scopes

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

namestringrequired

descriptionstring

languagestring

A language code, e.g. sv, en, en-GB.

first_messagestring

scriptstring

voice_preset_idstring (uuid) | null

phone_number_idstring (uuid) | null

Response

201application/json— Create a voice agent

idstring (uuid)required

An id (UUID).

object"voice_agent"required

namestring | nullrequired

descriptionstring | nullrequired

languagestring | nullrequired

first_messagestring | nullrequired

scriptstring | nullrequired

What the agent is told to do on a call (its prompt).

voice_preset_idstring (uuid) | nullrequired

phone_number_idstring (uuid) | nullrequired

publishedbooleanrequired

Live with the AI caller. Publishing (and changing a published agent's voice or tools) is done in the app.

created_atstring | nullrequired

updated_atstring | nullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/voice-agents

curl -X POST "https://api.norreach.app/v1/voice-agents" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Nora — staffing",
  "language": "sv",
  "first_message": "Hej, det är Nora från Example Care.",
  "script": "You call nurses who asked about shifts…"
}'

Create a voice agent

{
  "id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
  "object": "voice_agent",
  "name": "Nora — staffing",
  "description": "Books intro calls",
  "language": "sv",
  "first_message": "Hej, det är Nora från Example Care.",
  "script": "You call nurses who asked about shifts…",
  "voice_preset_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
  "phone_number_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "published": false,
  "created_at": "2026-10-01T08:00:00.000Z",
  "updated_at": "2026-11-05T08:00:00.000Z"
}