Documentation

Discord

TIXAE Agents

API Reference

Dashboard

Support

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

Agent Usage

bearerAgents

Get an agent's usage

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

When To Use TIXAE Agents

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

Connect Meta Channels

Get free 100GB/month of bandwidth & avoid credits charge on visits.

Setup Github Pages

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

Get Started

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

Workspace Usage

Introduction

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 the specified document from the agent's VF/VG KB

Get Single KB Doc

(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)

Delete KB Doc

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

Search Vector DB

(VG Agents Only) Returns agent knowledge base statistics

Get KB Stats

Returns agent conversations (metadata only)

Get All Convos

Export Convos

Create/Edit Convo

Delete Convo

Returns agent analytics data with start and stop timestamps

Get All Analytics

Returns analytics for a conversation of an agent

Get Convo Analytics

Add analytics to a conversation for an agent

Create/Edit Analytics

Deletes analytics from a conversation for an agent

Delete Convo Analytics

Deletes ENTIRE analytics for specified agent (Hard reset)

Delete All Analytics

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

Returns the agency associated with the workspace

Get Agency

Edit/Create Agency

Deletes the agency associated with the workspace

Delete Agency

Returns all organizations associated with the bearer token

Get Org Clients

New Org Client

Get Org Client

Edit Org Client

Delete Org Client

Returns all clients associated with the bearer token

Get Clients

New Client

Returns a client specified belonging to a workspace

Get Client

Updates a client specified belonging to a workspace

API Documentation

V3

Agents

Workspaces

Agent Usage

Authorizations

Path Parameters

Body

Response