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