:root {
    --head-color: #3f4346; /* #3f4346 */
}
.dark {
    --head-color: #e5e7eb; /* gray-200 */
}
/* Navigation items */
svg[width="3"][height="24"][viewBox="0 -9 3 24"] {
    background-color: transparent !important;
}
#navigation-items > div > ul > li > a > div,
#navigation-items > div > ul > li > div > div {
    font-weight: 550 !important;
    color: var(--head-color) !important;
    font-size: 0.93rem !important;
    margin-bottom: 0.2rem !important;
}

#navigation-items > div > ul > li > div > svg:first-of-type,
#navigation-items > div > ul > li > a > svg:first-of-type {
    background-color: var(--head-color);
    margin-bottom: 0.2rem !important;
}


Returns the specified document from the agent’s VF/VG Knowledge Base, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Single KB Doc

Authorization

Get a Knowledge Base by id

TIXAE Agents

Create, Test, and Deploy AI Voice + Text Agents in Seconds.

Introduction

The following is the API reference to control your account and agents through REST requests.

Get Started

How to authenticate with the TIXAE Agents API.

Authentication

The following are the available API endpoints.

API Endpoints

Get Agent

Create/Edit Agent

Delete Agent

Chat Interact

Configure the chat history state of the conversation and the associated metadata (name, email, etc)

Configure State

Returns workspace associated with the bearer token

Get Workspace

Edit Workspace

Deletes the workspace associated with the bearer token, only works if the workspace doesn't have any load tokens and hasn't paid and is not the main workspace associated with an account.

Delete Workspace

Community

Status

Pricing

Affiliate Program

API Reference

Dashboard

Support

Our take on the AI field and how TIXAE Agents fits in.

When To Use TIXAE Agents

How TIXAE Works

Connect your business portfolio assets like a facebook/instagram business pages to your AI agent.

Connect Meta Channels

Learn how to use the voice feature to transcribe speech to text, generate speech, and make phone calls.

Voice Introduction

How Voice Works

Learn how voice-to-voice interactions are priced.

Voice Pricing

Welcome to the Frequently Asked Questions (FAQs) section of the TIXAE Agents documentation. Here, we’ve compiled the most common queries to help you get started and troubleshoot any issues you may encounter.

Quick solutions to common issues you may encounter while using TIXAE Agents.

Troubleshooting

Get in touch with our team for assistance, feedback, or inquiries.

Contact Us

Creates a new workspace, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Create Workspace

This route must use the new V3 [endpoints](/api-reference/v3/intro).

Workspace Usage

Gets a workspace, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Workspace By ID

Gets all workspaces for a specific agent, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Workspaces

Deletes a workspace, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Updates a workspace, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Update Workspace

Creates a new AI agent with the specified configuration, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Create Agent

Gets an agent credit, LLM usage, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Agent Usage

Gets an agent, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Agent By ID

Gets all agents, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Agents

Deletes an agent, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Updates an agent, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Update Agent

Exports an agent template, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Export Agent Template

Imports an agent template, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Import Agent Template

This endpoint is used to make twilio call your number. Twilio will use the number assigned with your agent autmatically to make calls to your given phone number. It is required to pass your number so that Twilio can make a call to that number. If Query ?type=outgoing passed to URL, then Twilio will be waiting for you to call him.

Twilio Call (incoming / outgoing)

This endpoint is used to import a twilio number.

Import a Twilio Number

This endpoint is used to buy a twilio number.

Buy a Twilio Number

Creates a new tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Create Tool

Gets all tools for a specific agent, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Tools

Gets a tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Tool By ID

Deletes a tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Delete Tool

Updates a tool, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Update Tool

Creates a new variable, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Create Variable

Gets all variables for a specific agent, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Variables

Gets a variable, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Variable By ID

Deletes a variable, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Delete Variable

Updates a variable, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Update Variable

Creates a new lead with the specified configuration, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Create Lead

Gets all leads, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Leads

Gets a lead by ID, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get Lead By ID

Deletes a lead with the specified configuration, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Delete Lead

Updates a lead with the specified configuration, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Update Lead

(VG agents only) Adds a new document to the agent's knowledge base, if your agent is built with VF use [Voiceflow's API instead](https://developer.voiceflow.com/reference/project). This route must use the new V3 [endpoints](/api-reference/v3/intro).

Create KB

Retrieves all the KB docs for an agent, this route must use the new V3 [endpoints](/api-reference/v3/intro).

Get agent KB docs

(VG agents only) Returns agent's knowledge base stats, if your agent is built with VF use [Voiceflow's API instead](https://developer.voiceflow.com/reference/project). This route must use the new V3 [endpoints](/api-reference/v3/intro).

Get KB Stats

(VG agents only) Deletes a document from the agent's knowledge base, if your agent is built with VF use [Voiceflow's API instead](https://developer.voiceflow.com/reference/project). This route must use the new V3 [endpoints](/api-reference/v3/intro).

Delete KB Doc

(VG agents only) Updates knowledge base, if your agent is built with VF use [Voiceflow's API instead](https://developer.voiceflow.com/reference/project). This route must use the new V3 [endpoints](/api-reference/v3/intro).

Update KB Doc

Creates a new conversation for the specified agent, using the V3 [endpoints](/api-reference/v3/intro).

Create Conversation

Updates an existing conversation for the specified agent, using the V3 [endpoints](/api-reference/v3/intro).

Update Conversation

Retrieves all conversations associated with a specific agent, using the V3 [endpoints](/api-reference/v3/intro).

Get Agent Conversations

Retrieves details of a specific conversation for the specified agent, using the V3 [endpoints](/api-reference/v3/intro).

Get Single Conversation

Deletes a specific conversation for the specified agent, using the V3 [endpoints](/api-reference/v3/intro).

Delete Conversation

Exports all conversations for a specified agent in a suitable format for download, using the V3 [endpoints](/api-reference/v3/intro).

Export Agent Conversations

Exports a single conversation for the specified agent in a format suitable for download, using the V3 [endpoints](/api-reference/v3/intro).

Export Conversation

Retrieve a list of all organizations the authenticated user has access to

Get All Organizations

Retrieve a list of agents belonging to a specific organization

Get Organization Agents

Retrieve a list of clients belonging to a specific organization

Get Organization Clients

Returns the specified document from the agent's VF/VG KB

(VG agents only) Adds a new document to the agent's knowledge base, if your agent is built with VF use [Voiceflow's API instead](https://developer.voiceflow.com/reference/project)

Create/Edit KB Doc

(VG agents only) Deletes a document from the agent's knowledge base, if your agent is built with VF use [Voiceflow's API instead](https://developer.voiceflow.com/reference/project)

Get KB Docs

(VG Agents Only) Searches the agent's knowledge base

Search KB Docs

(VG Agents Only) Searches the agent's knowledge base using vectors

API Reference

API Documentation

V3

Agents

Workspaces

Get Single KB Doc

Authorizations

Path Parameters

Response