Skip to content
vocapable.Docs

Create Mobile Agent

POST
/v1/mobile/agents
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "name": "example", "use_case": "receptionist", "assistant_name": "Alex", "language": "en", "knowledge_pack_id": "example", "knowledge_pack_version": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
<= 255 characters

Unique key for this draft change. Retry with the same key and body to replay the saved result instead of repeating the change. Stored for 24 hours; a replay carries Idempotent-Replay: true.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MobileAgentDraftCreate

A bounded starter, with company-owned knowledge pinned explicitly.

object
name
required
Name
string
>= 1 characters <= 200 characters
use_case
required
Use Case
string
Allowed values: receptionist staffing recruiting reminder sdr survey custom
assistant_name
Assistant Name
string
default: Alex >= 1 characters <= 80 characters
language
Language
string
default: en
Allowed values: en es
knowledge_pack_id
Any of:
string
>= 1 characters <= 128 characters
knowledge_pack_version
Any of:
integer
>= 1

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
MobileAgent
object
id
required
Id
string
name
required
Name
string
use_case
required
Use Case
string
status
required
Status
string
latest_version
required
Any of:
integer
updated_at
required
Updated At
string format: date-time
Examplegenerated
{
  "id": "example",
  "name": "example",
  "use_case": "example",
  "status": "example",
  "latest_version": 1,
  "updated_at": "2026-04-15T12:00:00Z"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}