API Documentation
V3
- Get Started
- Workspaces
- Agents
Agents
- Introduction
- GETGet Agent
- POSTCreate/Edit Agent
- DELDelete Agent
- POSTChat Interact
- POSTConfigure State
- 🧠 Knowledge Base
- 💬 Conversations
- 📊 Analytics
Workspaces
Get Agency
Returns the agency associated with the workspace
Authorizations
Workspace secret API key, found in the workspace settings page (top left).
Response
Agency object
The name of the agency.
Address of the agency.
Text for agency branding (supports markdown).
Custom CSS for the agency to inject on the dashboard.
(Edit only from dashboard) Custom domain for the agency.
MUST JSON.stringify() this object before passing it to the API.
Custom theme object for the agent
Array length of 9 where every item is an array of HSL values: [50, 50, 50]
Primary hex color for the theme, example: '#000000'
Theme type
dark
, light
URL to the agency's dark mode square photo.
Indicates if human handoff is enabled.
Google font used by the agency Browse fonts
The unique identifier for the agency.
Indicates if the custom domain is verified.
Indicates if the subdomain is verified.
Main website URL for the agency.
API key for OpenAI.
Default OpenAI model for the agency.
gpt-3.5-turbo
, gpt-4-1106-preview
Privacy policy page URL.
Domain for resend email.
Identifier for the resend email domain.
JSON string representing resend email domain records.
Status of the resend email domain.
not_started
, pending
, verified
, failure
, temporary_failure
Secret key for the agency.
URL to the agency's square photo.
Support email address for the agency.
Color usage for the theme.
gradient
, colorful
, plain
Theme variant for the agency.
default
, bordered
, flat
, faded
Terms of service page URL.
The owner user/workspace associated with the agency.
(Edit only from dashboard) subdomain for the agency.
Indicates if the agency has TIXAE Agents branding.