AgentCreate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/agentline-cloud/json-schema/agentline-cloud-agent-create-schema.json",
  "title": "AgentCreate",
  "x-generated": "2026-11-01",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/agentline-cloud-openapi.json#/components/schemas/AgentCreate",
  "properties": {
    "name": {
      "type": "string",
      "title": "Name",
      "description": "Display name for the AI voice agent"
    },
    "system_prompt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "System Prompt",
      "description": "Default instructions for the agent's personality and behavior on ALL calls (inbound and outbound). Can be overridden per-call via POST /v1/calls."
    },
    "initial_greeting": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Initial Greeting",
      "description": "Default opening line spoken on ALL calls (inbound and outbound), e.g. 'Hello, how can I help you today?'. Can be overridden per-call via POST /v1/calls."
    },
    "voice_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Voice Id",
      "description": "Voice the agent speaks with: a voice_id from list_available_voices or a legacy preset name (e.g. 'female-1'); defaults to the system voice if not set"
    },
    "speech_language": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Speech Language",
      "description": "BCP-47 locale the agent listens and speaks in, e.g. 'en-US', 'hi-IN'. 'auto' (or unset) keeps multilingual auto-detection. Allowed values are listed under 'languages' by list_available_voices."
    },
    "speaking_speed": {
      "anyOf": [
        {
          "type": "number",
          "maximum": 1.5,
          "minimum": 0.6
        },
        {
          "type": "null"
        }
      ],
      "title": "Speaking Speed",
      "description": "Speaking pace multiplier from 0.6 (slower) to 1.5 (faster); 1.0 is the voice's natural pace."
    },
    "transfer_number": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Transfer Number",
      "description": "Number a live call is transferred to. Only the owner phone is allowed, so leave it out or send the same E.164 number as owner_phone; setting owner_phone fills it in."
    },
    "voicemail_message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Voicemail Message",
      "description": "Message the AI agent leaves if the call goes to voicemail"
    },
    "owner_phone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Owner Phone",
      "description": "Owner's phone number in E.164 format (e.g. '+12125551234'). Calls from this number enter task mode. This is also the only number a live call can be transferred to."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "name"
  ]
}