API DOCSVOICE GATEWAYSECURITY

Agent

The Agent API handles methods to create and manage each agent and its relations of a Virtual Agent.

API SUBPATH: eva-generative-service

Supervisor

Pagination and Listings

Searches and paginates through supervisors

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
pageinteger · int32Optional

Current page, starting at 1

Default: 1Example: 1
sizeinteger · int32Optional

Size of the page

Default: 5Example: 5
orderBystringOptional

Field to sort by

Default: updatedAtExample: updatedAt
directionstringOptional

Sort direction (ASC or DESC)

Default: DESCExample: DESC
searchTermstringOptional

Optional search term to filter supervisors

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors HTTP/1.1
Host: 
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageNumber": 1,
    "paged": true,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {}
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

CRUD Operations

Retrieve a supervisor by its UUID

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

supervisorUUIDstringRequired

The supervisor UUID to retrieve

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors/{supervisorUUID}
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors/{supervisorUUID} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "role": "Customer Support Agent",
  "flowUUID": "123e4567-e89b-12d3-a456-426614174001",
  "goal": "Assist customers with their inquiries",
  "instructions": "text",
  "guardrails": "text",
  "persona": {
    "uuid": "text",
    "name": "text",
    "image": "text",
    "backstory": "text",
    "personality": "text",
    "communicationStyle": "POLITE_AND_PERSUASIVE"
  },
  "inheritFromSupervisor": true,
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "functions": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "documentCount": 1,
      "searchType": {
        "type": "text",
        "semanticWeight": 1,
        "fullTextWeight": 1
      },
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1
    }
  ],
  "heirs": [
    {
      "role": "text"
    }
  ]
}

Update an existing supervisor by its UUID

put
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

supervisorUUIDstringRequired

The supervisor UUID to update

Body

Data Transfer Object representing the configuration and attributes for a supervisor

instructionsstringOptional

Instructions for the supervisor

Example: Oversee all customer service interactions
guardrailsstringOptional

Guardrails and limitations for the supervisor

Example: Ensure professional communication
Responses
200

Ok

application/json
put
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors/{supervisorUUID}
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors/{supervisorUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 339

{
  "instructions": "Oversee all customer service interactions",
  "guardrails": "Ensure professional communication",
  "persona": {
    "uuid": "text"
  },
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  }
}
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "role": "Customer Support Agent",
  "flowUUID": "123e4567-e89b-12d3-a456-426614174001",
  "goal": "Assist customers with their inquiries",
  "instructions": "text",
  "guardrails": "text",
  "persona": {
    "uuid": "text",
    "name": "text",
    "image": "text",
    "backstory": "text",
    "personality": "text",
    "communicationStyle": "POLITE_AND_PERSUASIVE"
  },
  "inheritFromSupervisor": true,
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "functions": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "documentCount": 1,
      "searchType": {
        "type": "text",
        "semanticWeight": 1,
        "fullTextWeight": 1
      },
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1
    }
  ],
  "heirs": [
    {
      "role": "text"
    }
  ]
}

Auxiliary Methods

Retrieve the default supervisor

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors/default
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/supervisors/default HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "role": "Customer Support Agent",
  "flowUUID": "123e4567-e89b-12d3-a456-426614174001",
  "goal": "Assist customers with their inquiries",
  "instructions": "text",
  "guardrails": "text",
  "persona": {
    "uuid": "text",
    "name": "text",
    "image": "text",
    "backstory": "text",
    "personality": "text",
    "communicationStyle": "POLITE_AND_PERSUASIVE"
  },
  "inheritFromSupervisor": true,
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "functions": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "documentCount": 1,
      "searchType": {
        "type": "text",
        "semanticWeight": 1,
        "fullTextWeight": 1
      },
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1
    }
  ],
  "heirs": [
    {
      "role": "text"
    }
  ]
}

Agent

Pagination and Listings

Searches and paginates through agents

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
pageinteger · int32Optional

Current page, starting at 1

Default: 1Example: 1
sizeinteger · int32Optional

Size of the page

Default: 5Example: 5
orderBystringOptional

The field to order results by

Default: updatedAtExample: updatedAt
directionstringOptional

The sort direction (ASC or DESC)

Default: DESCExample: DESC
searchTermstringOptional

Optional search term to filter results

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents HTTP/1.1
Host: 
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageNumber": 1,
    "paged": true,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {}
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Perform a quick search for agent names

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
namestringRequired

The name of the agent for quick search

limitinteger · int32Optional

The maximum number of results to return

Default: 6Example: 6
Header parameters
x-request-idstringOptional
Responses
200

Ok

application/json
Responsestring
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/quicksearch
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/quicksearch?name=text HTTP/1.1
Host: 
Accept: */*

text

CRUD Operations

Create a new agent

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data Transfer Object representing the parameters required to create an agent

rolestringRequired

The role of the agent

Example: Customer Support Agent
goalstringRequired

The goal of the agent

Example: Assist customers with their inquiries
instructionsstringOptional

Detailed instructions for the agent

Example: Always be polite and helpful
guardrailsstringOptional

Guardrails and limitations for the agent

Example: Do not provide personal information
inheritFromSupervisorbooleanRequired

Whether the agent should inherit configurations from supervisor

Responses
201

Created

application/json
post
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 482

{
  "role": "Customer Support Agent",
  "goal": "Assist customers with their inquiries",
  "instructions": "Always be polite and helpful",
  "guardrails": "Do not provide personal information",
  "persona": {
    "uuid": "text"
  },
  "constraints": [
    {
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "inheritFromSupervisor": true,
  "functions": [
    {
      "uuid": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text"
    }
  ]
}
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "role": "Customer Support Agent",
  "flowUUID": "123e4567-e89b-12d3-a456-426614174001",
  "goal": "Assist customers with their inquiries",
  "instructions": "text",
  "guardrails": "text",
  "persona": {
    "uuid": "text",
    "name": "text",
    "image": "text",
    "backstory": "text",
    "personality": "text",
    "communicationStyle": "POLITE_AND_PERSUASIVE"
  },
  "inheritFromSupervisor": true,
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "functions": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "documentCount": 1,
      "searchType": {
        "type": "text",
        "semanticWeight": 1,
        "fullTextWeight": 1
      },
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1
    }
  ],
  "heirs": [
    {
      "role": "text"
    }
  ]
}

Find an agent by its UUID

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

agentUUIDstringRequired

The specific agent UUID to retrieve

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/{agentUUID}
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/{agentUUID} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "role": "Customer Support Agent",
  "flowUUID": "123e4567-e89b-12d3-a456-426614174001",
  "goal": "Assist customers with their inquiries",
  "instructions": "text",
  "guardrails": "text",
  "persona": {
    "uuid": "text",
    "name": "text",
    "image": "text",
    "backstory": "text",
    "personality": "text",
    "communicationStyle": "POLITE_AND_PERSUASIVE"
  },
  "inheritFromSupervisor": true,
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "functions": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "documentCount": 1,
      "searchType": {
        "type": "text",
        "semanticWeight": 1,
        "fullTextWeight": 1
      },
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1
    }
  ],
  "heirs": [
    {
      "role": "text"
    }
  ]
}

Update an existing agent by its UUID

put
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

agentUUIDstringRequired

The specific agent UUID to update

Body

Data Transfer Object representing the necessary fields for updating an agent

rolestringRequired

The role of the agent

Example: Customer Support Agent
goalstringRequired

The goal of the agent

Example: Assist customers with their inquiries
instructionsstringOptional

Detailed instructions for the agent

Example: Always be polite and helpful
guardrailsstringOptional

Guardrails and limitations for the agent

Example: Do not provide personal information
inheritFromSupervisorbooleanRequired

Whether the agent should inherit configurations from supervisor

Responses
200

Ok

application/json
put
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/{agentUUID}
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/{agentUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 496

{
  "role": "Customer Support Agent",
  "goal": "Assist customers with their inquiries",
  "instructions": "Always be polite and helpful",
  "guardrails": "Do not provide personal information",
  "persona": {
    "uuid": "text"
  },
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "inheritFromSupervisor": true,
  "functions": [
    {
      "uuid": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text"
    }
  ]
}
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "role": "Customer Support Agent",
  "flowUUID": "123e4567-e89b-12d3-a456-426614174001",
  "goal": "Assist customers with their inquiries",
  "instructions": "text",
  "guardrails": "text",
  "persona": {
    "uuid": "text",
    "name": "text",
    "image": "text",
    "backstory": "text",
    "personality": "text",
    "communicationStyle": "POLITE_AND_PERSUASIVE"
  },
  "inheritFromSupervisor": true,
  "constraints": [
    {
      "uuid": "text",
      "value": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameters": {
    "maximumTokens": 1,
    "requestTimeout": 1,
    "temperature": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1
  },
  "functions": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "knowledge": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "documentCount": 1,
      "searchType": {
        "type": "text",
        "semanticWeight": 1,
        "fullTextWeight": 1
      },
      "previousUserInput": 1,
      "threshold": 1,
      "topK": 1
    }
  ],
  "heirs": [
    {
      "role": "text"
    }
  ]
}

Delete an agent by its UUID

delete
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

agentUUIDstringRequired

The specific agent UUID to delete

Responses
200

Ok

application/json
delete
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/{agentUUID}
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/{agentUUID} HTTP/1.1
Host: 
Accept: */*

{
  "name": "My Agent"
}

Auxiliary Methods

Check if an agent identifier is already in use

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data Transfer Object used to validate and check the existence or usage of a specific value

valuestringRequired

The value to be checked

Example: agent-identifier
uuidstringOptional

Optional unique identifier of an associated entity

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
200

Ok

application/json
post
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/check-identifier
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/agents/check-identifier HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "value": "agent-identifier",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "used": true
}

Persona

Pagination and Listings

Searches and paginates through personas

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
pageinteger · int32Optional

Current page, starting at 1

Default: 1Example: 1
sizeinteger · int32Optional

Size of the page

Default: 5Example: 5
orderBystringOptional

The field to order results by

Default: updatedAtExample: updatedAt
directionstringOptional

The sort direction (ASC or DESC)

Default: DESCExample: DESC
searchTermstringOptional

Optional search term to filter results

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas HTTP/1.1
Host: 
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageNumber": 1,
    "paged": true,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {}
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Perform a quick search for persona names

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
namestringRequired

The name to search for

limitinteger · int32Optional

The maximum number of results to return

Default: 6Example: 6
Header parameters
x-request-idstringOptional
Responses
200

Ok

application/json
Responsestring
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/quicksearch
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/quicksearch?name=text HTTP/1.1
Host: 
Accept: */*

text

Retrieve a list of personas for dropdown

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses
200

Ok

application/json
Responsestring
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/dropdown
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/dropdown HTTP/1.1
Host: 
Accept: */*

text

CRUD Operations

Create a new persona

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data Transfer Object representing the fields for creating or updating a persona

namestringRequired

Name of the persona

Example: AI Assistant
imagestringOptional

Image URL or base64 encoded image for the persona

Example: https://example.com/avatar.jpg
backstorystringOptional

Backstory of the persona

Example: An experienced customer service representative
personalitystringOptional

Personality traits of the persona

Example: Friendly, helpful, and professional
communicationStylestring · enumOptional

Different styles of communication.

Possible values:
Responses
201

Created

application/json
post
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "name": "AI Assistant",
  "image": "https://example.com/avatar.jpg",
  "backstory": "An experienced customer service representative",
  "personality": "Friendly, helpful, and professional",
  "communicationStyle": "POLITE_AND_PERSUASIVE"
}
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "AI Assistant",
  "image": "https://example.com/avatar.jpg",
  "backstory": "An experienced customer service representative",
  "personality": "Friendly, helpful, and professional",
  "communicationStyle": "POLITE_AND_PERSUASIVE",
  "agents": [
    {
      "role": "text"
    }
  ]
}

Retrieve a persona by its UUID

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

personaUUIDstringRequired

The specific persona UUID to retrieve

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/{personaUUID}
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/{personaUUID} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "AI Assistant",
  "image": "https://example.com/avatar.jpg",
  "backstory": "An experienced customer service representative",
  "personality": "Friendly, helpful, and professional",
  "communicationStyle": "POLITE_AND_PERSUASIVE",
  "agents": [
    {
      "role": "text"
    }
  ]
}

Update an existing persona by its UUID

put
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

personaUUIDstringRequired

The specific persona UUID to update

Body

Data Transfer Object representing the fields for creating or updating a persona

namestringRequired

Name of the persona

Example: AI Assistant
imagestringOptional

Image URL or base64 encoded image for the persona

Example: https://example.com/avatar.jpg
backstorystringOptional

Backstory of the persona

Example: An experienced customer service representative
personalitystringOptional

Personality traits of the persona

Example: Friendly, helpful, and professional
communicationStylestring · enumOptional

Different styles of communication.

Possible values:
Responses
200

Ok

application/json
put
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/{personaUUID}
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/{personaUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "name": "AI Assistant",
  "image": "https://example.com/avatar.jpg",
  "backstory": "An experienced customer service representative",
  "personality": "Friendly, helpful, and professional",
  "communicationStyle": "POLITE_AND_PERSUASIVE"
}
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "AI Assistant",
  "image": "https://example.com/avatar.jpg",
  "backstory": "An experienced customer service representative",
  "personality": "Friendly, helpful, and professional",
  "communicationStyle": "POLITE_AND_PERSUASIVE",
  "agents": [
    {
      "role": "text"
    }
  ]
}

Delete a persona by its UUID

delete
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

personaUUIDstringRequired

The specific persona UUID to delete

Responses
200

Ok

application/json
delete
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/{personaUUID}
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/{personaUUID} HTTP/1.1
Host: 
Accept: */*

{
  "name": "My Agent"
}

Auxiliary Methods

Check if a persona identifier is already in use

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data Transfer Object used to validate and check the existence or usage of a specific value

valuestringRequired

The value to be checked

Example: agent-identifier
uuidstringOptional

Optional unique identifier of an associated entity

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
200

Ok

application/json
post
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/check-identifier
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/check-identifier HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "value": "agent-identifier",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "used": true
}

Retrieve persona summary information

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/summary
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/personas/summary HTTP/1.1
Host: 
Accept: */*

{
  "used": 5,
  "limit": 10
}

Function

Pagination and Listings

Searches and paginates through functions

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
pageinteger · int32Optional

Current page, starting at 1

Default: 1Example: 1
sizeinteger · int32Optional

Size of the page

Default: 5Example: 5
orderBystringOptional

Field to sort by

Default: updatedAtExample: updatedAt
directionstringOptional

Sort direction (ASC or DESC)

Default: DESCExample: DESC
searchTermstringOptional

Search term for filtering

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions HTTP/1.1
Host: 
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "pageable": {
    "unpaged": true,
    "pageNumber": 1,
    "paged": true,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {}
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Perform a quick search for function names

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Query parameters
namestringRequired

Name to filter

limitinteger · int32Optional

Maximum number of results to return

Default: 6Example: 6
Header parameters
x-request-idstringOptional
Responses
200

Ok

application/json
Responsestring
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/quicksearch
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/quicksearch?name=text HTTP/1.1
Host: 
Accept: */*

text

CRUD Operations

Create a new function

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data Transfer Object representing the creation of an Agent Function

namestringRequired

Name of the function

Example: GetWeatherFunction
descriptionstring · max: 1024Required

Description of the function

Example: Function to get current weather information
parameterJsonstringOptional

JSON string representing function parameters

Example: {"type":"object","properties":{}}
Responses
201

Created

application/json
post
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "name": "GetWeatherFunction",
  "description": "Function to get current weather information",
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameterJson": "{\"type\":\"object\",\"properties\":{}}",
  "parameters": [
    {
      "name": "text",
      "type": "STRING",
      "description": "text",
      "variable": "text",
      "rules": [
        {
          "value": "text"
        }
      ]
    }
  ]
}
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "GetWeatherFunction",
  "description": "Function to get current weather information",
  "agents": [
    {
      "role": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameterJson": "{\"type\":\"object\",\"properties\":{}}",
  "parameters": [
    {
      "uuid": "text",
      "name": "text",
      "type": "STRING",
      "description": "text",
      "variable": "text",
      "rules": [
        {
          "uuid": "text",
          "value": "text"
        }
      ]
    }
  ]
}

Find a function by its UUID

get
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

functionUUIDstringRequired

Function UUID

Responses
200

Ok

application/json
get
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/{functionUUID}
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/{functionUUID} HTTP/1.1
Host: 
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "GetWeatherFunction",
  "description": "Function to get current weather information",
  "agents": [
    {
      "role": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameterJson": "{\"type\":\"object\",\"properties\":{}}",
  "parameters": [
    {
      "uuid": "text",
      "name": "text",
      "type": "STRING",
      "description": "text",
      "variable": "text",
      "rules": [
        {
          "uuid": "text",
          "value": "text"
        }
      ]
    }
  ]
}

Update an existing function by its UUID

put
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

functionUUIDstringRequired

Function UUID to update

Body

Data Transfer Object for updating an existing agent function

namestringRequired

Name of the function

Example: GetWeatherFunction
descriptionstring · max: 1024Required

Description of the function

Example: Function to get current weather information
parameterJsonstringOptional

JSON string representing function parameters

Example: {"type":"object","properties":{}}
Responses
200

Ok

application/json
put
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/{functionUUID}
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/{functionUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 327

{
  "name": "GetWeatherFunction",
  "description": "Function to get current weather information",
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameterJson": "{\"type\":\"object\",\"properties\":{}}",
  "parameters": [
    {
      "uuid": "text",
      "name": "text",
      "type": "STRING",
      "description": "text",
      "variable": "text",
      "rules": [
        {
          "uuid": "text",
          "value": "text"
        }
      ]
    }
  ]
}
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "GetWeatherFunction",
  "description": "Function to get current weather information",
  "agents": [
    {
      "role": "text"
    }
  ],
  "tags": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "parameterJson": "{\"type\":\"object\",\"properties\":{}}",
  "parameters": [
    {
      "uuid": "text",
      "name": "text",
      "type": "STRING",
      "description": "text",
      "variable": "text",
      "rules": [
        {
          "uuid": "text",
          "value": "text"
        }
      ]
    }
  ]
}

Delete a function by its UUID

delete
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

functionUUIDstringRequired

Function UUID to delete

Responses
200

Ok

application/json
delete
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/{functionUUID}
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/{functionUUID} HTTP/1.1
Host: 
Accept: */*

{
  "name": "My Agent"
}

Auxiliary Methods

Check if a function identifier is already in use

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data Transfer Object used to validate and check the existence or usage of a specific value

valuestringRequired

The value to be checked

Example: agent-identifier
uuidstringOptional

Optional unique identifier of an associated entity

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
200

Ok

application/json
post
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/check-identifier
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/functions/check-identifier HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "value": "agent-identifier",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "used": true
}

Variable

Auxiliary Methods

Check if a variable is currently in use within a bot's configuration

post
Path parameters
orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Data Transfer Object used to validate and check the existence or usage of a specific value

valuestringRequired

The value to be checked

Example: agent-identifier
uuidstringOptional

Optional unique identifier of an associated entity

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
200

Ok

application/json
post
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/variables
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/variables HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "value": "agent-identifier",
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "used": true
}
PreviousInstance APINextKnowledge AI

Last updated