Create agent

Python

from superu import SuperU

client = SuperU("YOUR_SUPERU_API_KEY")

payload = {
    "type": "outbound",
    "name": "Demo Assistant",
    "company_name": "SuperU",
    "assistant_name": "Ava",
    "first_message": "Hi, thanks for taking the call.",
    "voice_id": "90ipbRoKi4CpHXvKVtl0",
    "voice_provider": "11labs",
    "system_prompt": "You are a friendly assistant.",
    "industry": "Blank Template",
    "useCase": "Blank Template",
    "form_model": {
        "key": "value"
    },
    "assistant_data": {
        "key": "value"
    },
    "knowledgeBase": [
        "kb_abc123"
    ],
    "tools": [
        "tool_01HXR9259WDZ2X3ZZKQ7HDG4C2"
    ],
    "call_forwarding": {
        "key": "value"
    }
}

response = client.agents.create_agent(**payload)
print(response)

curl --request POST \\
  --url https://voip-middlware.superu.ai/agent/create \\
  --header 'superU-Api-Key: YOUR_SUPERU_API_KEY' \\
  --data '{
  "type": "outbound",
  "name": "Demo Assistant",
  "company_name": "SuperU",
  "assistant_name": "Ava",
  "first_message": "Hi, thanks for taking the call.",
  "voice_id": "90ipbRoKi4CpHXvKVtl0",
  "voice_provider": "11labs",
  "system_prompt": "You are a friendly assistant.",
  "industry": "Blank Template",
  "useCase": "Blank Template",
  "form_model": {
    "key": "value"
  },
  "assistant_data": {
    "key": "value"
  },
  "knowledgeBase": [
    "kb_abc123"
  ],
  "tools": [
    "tool_01HXR9259WDZ2X3ZZKQ7HDG4C2"
  ],
  "call_forwarding": {
    "key": "value"
  }
}'

{
  "status": "success",
  "agent_id": "ag_01HXR8FM5QYCVXAK4TYFJ4AEP0",
  "message": "Agent created successfully"
}

{
  "status": "error",
  "code": "BAD_REQUEST",
  "message": "Request validation failed."
}

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Invalid or missing superU-Api-Key."
}

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "Resource not found."
}

{
  "status": "error",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected server error occurred."
}

{
  "status": "error",
  "code": "NOT_IMPLEMENTED",
  "message": "This endpoint is not implemented for your workspace."
}

POST

agent

create

Python

from superu import SuperU

client = SuperU("YOUR_SUPERU_API_KEY")

payload = {
    "type": "outbound",
    "name": "Demo Assistant",
    "company_name": "SuperU",
    "assistant_name": "Ava",
    "first_message": "Hi, thanks for taking the call.",
    "voice_id": "90ipbRoKi4CpHXvKVtl0",
    "voice_provider": "11labs",
    "system_prompt": "You are a friendly assistant.",
    "industry": "Blank Template",
    "useCase": "Blank Template",
    "form_model": {
        "key": "value"
    },
    "assistant_data": {
        "key": "value"
    },
    "knowledgeBase": [
        "kb_abc123"
    ],
    "tools": [
        "tool_01HXR9259WDZ2X3ZZKQ7HDG4C2"
    ],
    "call_forwarding": {
        "key": "value"
    }
}

response = client.agents.create_agent(**payload)
print(response)

curl --request POST \\
  --url https://voip-middlware.superu.ai/agent/create \\
  --header 'superU-Api-Key: YOUR_SUPERU_API_KEY' \\
  --data '{
  "type": "outbound",
  "name": "Demo Assistant",
  "company_name": "SuperU",
  "assistant_name": "Ava",
  "first_message": "Hi, thanks for taking the call.",
  "voice_id": "90ipbRoKi4CpHXvKVtl0",
  "voice_provider": "11labs",
  "system_prompt": "You are a friendly assistant.",
  "industry": "Blank Template",
  "useCase": "Blank Template",
  "form_model": {
    "key": "value"
  },
  "assistant_data": {
    "key": "value"
  },
  "knowledgeBase": [
    "kb_abc123"
  ],
  "tools": [
    "tool_01HXR9259WDZ2X3ZZKQ7HDG4C2"
  ],
  "call_forwarding": {
    "key": "value"
  }
}'

{
  "status": "success",
  "agent_id": "ag_01HXR8FM5QYCVXAK4TYFJ4AEP0",
  "message": "Agent created successfully"
}

{
  "status": "error",
  "code": "BAD_REQUEST",
  "message": "Request validation failed."
}

{
  "status": "error",
  "code": "UNAUTHORIZED",
  "message": "Invalid or missing superU-Api-Key."
}

{
  "status": "error",
  "code": "NOT_FOUND",
  "message": "Resource not found."
}

{
  "status": "error",
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected server error occurred."
}

{
  "status": "error",
  "code": "NOT_IMPLEMENTED",
  "message": "This endpoint is not implemented for your workspace."
}

Authorizations

superU-Api-Key

string

header

required

Your SuperU API key.

Body

application/json

Request body for Create agent.

Agent Create Request schema.

type

enum<string>

Agent type

Available options:

inbound,

outbound

Example:

"outbound"

name

string

Internal agent name

Example:

"Demo Assistant"

company_name

string

Company name

Example:

"SuperU"

assistant_name

string

Assistant display name

Example:

"Ava"

first_message

string

First message spoken by the assistant

Example:

"Hi, thanks for taking the call."

voice_id

string

Voice ID

Example:

"90ipbRoKi4CpHXvKVtl0"

voice_provider

string

Voice provider

Example:

"11labs"

system_prompt

string

System prompt template.

Variable syntax:

Use {{ variable_name }}
Spaces inside braces are required (e.g., {{ name }})
Keep them same when passing the variables in the Create Call request

Example:

"You are a helpful assistant."

industry

string

Industry template

Example:

"Blank Template"

useCase

string

Use case template

Example:

"Blank Template"

form_model

object

Form model value.

Example:

{ "key": "value" }

assistant_data

object

Assistant data value.

Example:

{ "key": "value" }

knowledgeBase

string[]

List of knowledge base UUIDs (kb_uuid) to attach to the agent.

Example:

["kb_abc123"]

tools

string[]

Tools value.

Example:

["tool_01HXR9259WDZ2X3ZZKQ7HDG4C2"]

call_forwarding

object

Call forwarding value.

Example:

{ "key": "value" }

Response

Agent created

A generic response schema for successful API calls.

status

string

Indicates if the request was successful.

Example:

"success"

message

string

A descriptive message about the result of the request.

Example:

"Request completed successfully"

data

object

The payload of the response, if any.

Get call logs and analysis List agents

Getting Started

Calls

Agents

Agent Versions

Phone Numbers

Tools

Folders

Contacts

Audiences

Knowledge Base

Campaigns

Webhooks

Authorizations

Body

Response