Skip to main content
POST
/
v0
/
applications
Create a new application
curl --request POST \
  --url https://api.avidoai.com/v0/applications \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Customer Support Bot",
  "slug": "customer-support-bot",
  "type": "CHATBOT",
  "description": "AI assistant for customer support inquiries",
  "context": "You are a helpful customer support assistant...",
  "environment": "DEV"
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "title": "Customer Support Bot",
    "slug": "customer-support-bot",
    "description": "AI assistant for customer support inquiries",
    "context": "You are a helpful customer support assistant...",
    "language": "en",
    "type": "CHATBOT",
    "environment": "DEV",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z"
  }
}

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

Example:

"AI assistant for customer support inquiries"

​
context
string
default:""

Context/instructions for the application

Example:

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

​
environment
enum<string>
default:DEV

Environment of the application

Available options:
DEV,
PROD
Example:

"DEV"

Response

Successfully created application

Successful response containing the application data

​
data
Application · object
required

Application configuration and metadata