Skip to main content
POST
Create a new application

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new application

title
string
required

Title of the application

Minimum string length: 1
Example:

"Customer Support Bot"

slug
string
required

URL-friendly slug for the application

Minimum string length: 1
Example:

"customer-support-bot"

type
enum<string>
required

Type of the application

Available options:
CHATBOT,
AGENT
Example:

"CHATBOT"

description
string
default:""

Description of the application

Maximum string length: 2048
Example:

"AI assistant for customer support inquiries"

context
string
default:""

Context/instructions for the application

Maximum string length: 8192
Example:

"You are a helpful customer support assistant..."

language
enum<string>
default:en

Language of the application.

Available options:
da,
de,
en,
es,
fr,
it,
nl,
pt,
sv
Example:

"en"

environment
enum<string>
default:DEV

Environment of the application

Available options:
DEV,
PROD
Example:

"DEV"

humanAnnotationEnabled
boolean
default:false

Whether human annotation is enabled for this application

Example:

false

Response

Successfully created application

Successful response containing the application data

data
Application · object
required

Application configuration and metadata