Get Agency - TIXAE Agents

Documentation

Discord

API Reference

API Documentation

Get Started

V3

Get Started
📁 Workspaces
🤖 Agents
Calls & Numbers
🔨 Tools
✖️ Variables
👥 Leads
🧠 Knowledge Base

Agents

Workspaces

GET

agencies

curl --request GET \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/agencies \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "Agencies retrieved successfully",
  "data": {
    "ID": "<string>",
    "userId": "<string>",
    "name": "<string>",
    "squarePhotoURL": "<string>",
    "darkModeSquarePhotourl": "<string>",
    "brandingText": "<string>",
    "customDomain": "<string>",
    "VGsubDomain": "<string>",
    "customThemeJSONString": "<string>",
    "isVerifiedSubDomain": true,
    "isVerifiedCustomDomain": true,
    "withVGBranding": true,
    "themeVariant": "default",
    "themeColorUsage": "gradient",
    "googleFont": "<string>",
    "mainWebsite": "<string>",
    "supportEmail": "<string>",
    "tosPage": "<string>",
    "privacyPolicypPage": "<string>",
    "secret": "<string>",
    "OPENAI_API_KEY": "<string>",
    "OPENAI_DEFAULT_MODEL": "gpt-3.5-turbo",
    "address": "<string>",
    "customCSS": "<string>",
    "enableHumanHandoff": true,
    "resendEmailDomain": "<string>",
    "resendEmailDomainId": "<string>",
    "resendEmailDomainStatus": "not_started",
    "resendEmailDomainRecords_JSON_STRING": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Workspace secret API key, found in the workspace settings page (top left).

Response

200

application/json

Agency retrieved

success

boolean

message

string

data

object

Agency object

data.name

string

required

The name of the agency.

data.ID

string

The unique identifier for the agency.

data.userId

string

The owner user/workspace associated with the agency.

data.squarePhotoURL

string

URL to the agency's square photo.

data.darkModeSquarePhotourl

string

URL to the agency's dark mode square photo.

data.brandingText

string

Text for agency branding (supports markdown).

data.customDomain

string

(Edit only from dashboard) Custom domain for the agency.

data.VGsubDomain

string

(Edit only from dashboard) subdomain for the agency.

data.customThemeJSONString

object

MUST JSON.stringify() this object before passing it to the API.

Custom theme object for the agent

data.isVerifiedSubDomain

boolean

Indicates if the subdomain is verified.

data.isVerifiedCustomDomain

boolean

Indicates if the custom domain is verified.

data.withVGBranding

boolean

Indicates if the agency has TIXAE Agents branding.

data.themeVariant

enum<string>

Theme variant for the agency.

Available options:

default,

bordered,

flat,

faded

data.themeColorUsage

enum<string>

Color usage for the theme.

Available options:

gradient,

colorful,

plain

data.googleFont

string

Google font used by the agency Browse fonts

data.mainWebsite

string

Main website URL for the agency.

data.supportEmail

string

Support email address for the agency.

data.tosPage

string

data.privacyPolicypPage

string

data.secret

string

Secret key for the agency.

data.OPENAI_API_KEY

string

API key for OpenAI.

data.OPENAI_DEFAULT_MODEL

enum<string>

Default OpenAI model for the agency.

Available options:

gpt-3.5-turbo,

gpt-4-1106-preview

data.address

string

Address of the agency.

data.customCSS

string

Custom CSS for the agency to inject on the dashboard.

data.enableHumanHandoff

boolean

Indicates if human handoff is enabled.

data.resendEmailDomain

string

Domain for resend email.

data.resendEmailDomainId

string

Identifier for the resend email domain.

data.resendEmailDomainStatus

enum<string>

Status of the resend email domain.

Available options:

not_started,

pending,

verified,

failure,

temporary_failure

data.resendEmailDomainRecords_JSON_STRING

string

JSON string representing resend email domain records.

Delete Workspace Edit/Create Agency

curl --request GET \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/agencies \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "Agencies retrieved successfully",
  "data": {
    "ID": "<string>",
    "userId": "<string>",
    "name": "<string>",
    "squarePhotoURL": "<string>",
    "darkModeSquarePhotourl": "<string>",
    "brandingText": "<string>",
    "customDomain": "<string>",
    "VGsubDomain": "<string>",
    "customThemeJSONString": "<string>",
    "isVerifiedSubDomain": true,
    "isVerifiedCustomDomain": true,
    "withVGBranding": true,
    "themeVariant": "default",
    "themeColorUsage": "gradient",
    "googleFont": "<string>",
    "mainWebsite": "<string>",
    "supportEmail": "<string>",
    "tosPage": "<string>",
    "privacyPolicypPage": "<string>",
    "secret": "<string>",
    "OPENAI_API_KEY": "<string>",
    "OPENAI_DEFAULT_MODEL": "gpt-3.5-turbo",
    "address": "<string>",
    "customCSS": "<string>",
    "enableHumanHandoff": true,
    "resendEmailDomain": "<string>",
    "resendEmailDomainId": "<string>",
    "resendEmailDomainStatus": "not_started",
    "resendEmailDomainRecords_JSON_STRING": "<string>"
  }
}