API.md

Bolna API Documentation

Endpoints

Get Agent

Retrieves an agent's information by agent id.

Endpoint: GET /agent/{agent_id}

Parameters:

• agent_id (path) - string, required: Unique identifier of the agent

Create Agent

Creates a new agent with specified configuration.

Endpoint: POST /agent

Request Body:

{
  "agent_config": {
    "agent_name": "Alfred",
    "agent_type": "other",
    "tasks": [
      {
        "task_type": "conversation",
        "toolchain": {
          "execution": "parallel",
          "pipelines": [["transcriber", "llm", "synthesizer"]]
        },
        "tools_config": {
          "input": { "format": "wav", "provider": "twilio" },
          "output": { "format": "wav", "provider": "twilio" },
          "transcriber": {
            "encoding": "linear16",
            "language": "en",
            "provider": "deepgram",
            "stream": true
          },
          "llm_agent": {
            "agent_type": "simple_llm_agent",
            "agent_flow_type": "streaming",
            "llm_config": {
              "provider": "openai",
              "model": "gpt-4o-mini",
              "request_json": true
            }
          },
          "synthesizer": {
            "audio_format": "wav",
            "provider": "elevenlabs",
            "stream": true,
            "provider_config": {
              "voice": "George",
              "model": "eleven_turbo_v2_5",
              "voice_id": "JBFqnCBsd6RMkjVDRZzb"
            },
            "buffer_size": 100.0
          }
        },
        "task_config": {
          "hangup_after_silence": 30.0
        }
      }
    ],
    "agent_welcome_message": "How are you doing Bruce?"
  },
  "agent_prompts": {
    "task_1": {
      "system_prompt": "Why Do We Fall, Sir? So That We Can Learn To Pick Ourselves Up."
    }
  }
}

Response: 200 OK

{
  "agent_id": "uuid-string",
  "state": "created"
}

Edit Agent

Updates an existing agent's configuration.

Endpoint: PUT /agent/{agent_id}

Parameters:

• agent_id (path) - string, required: Unique identifier of the agent

Request Body: Same as Create Agent endpoint

Delete Agent

Deletes an agent from the system.

Endpoint: DELETE /agent/{agent_id}

Parameters:

• agent_id (path) - string, required: Unique identifier of the agent

Response: 200 OK

{
  "agent_id": "string",
  "state": "deleted"
}

Retrieves all agents from the system.

Endpoint: GET /all

Response: 200 OK

{
  "agents": [
    {
      "agent_id": "string",
      "data": {
        "agent_config": {
          "agent_name": "Alfred",
          "agent_type": "other",
          "tasks": []
        },
        "agent_prompts": {}
      }
    }
  ]
}