​
First of all please know your account region from the dashboard to know which endpoint to use from these:

Anything with /v3/ at the beginning will be using these endpoints:

​
V3 EU Region:

https://eu-TIXAE Agents-runtime-vbmbkqccuq-ey.a.run.app

​
V3 NA Region:

https://na-runtime.TIXAE Agents.org

If you use the incorrect endpoint the API will not work.

​
Authorization

  • We use Bearer token to authorize any request for agents (except for public interact, analytics endpoints), workspaces, Kb, conversations, analytics, etc
  • You can use either the agent secret key or the workspace secret, both are present in your dashboard.

To get a Workspace Secret: VG Dashboard > Top left > Select workspace you want > Copy Workspace secret

To get the Agent secret: VG Dashboard > Agent > Settings > Scroll down

​
Agent Platforms

  • You can currently interact with VG through either the built in AI engine or through Voiceflow, the agentPlatform defines how the agent will interact and function across the whole service.
  • The interact API of voiceflow inspires how we interact with VF/VG agents, when you do an interact POST request the action property functions the same as that on Voiceflow’s end.
Get StartedWorkspace Usage