Skip to main content
Convocore exposes multiple API surfaces, but for most new integrations you should start with V3 REST.

​
Choose the right API

​
V3 REST

Recommended for new integrations.
  • Bearer-authenticated
  • Resource-oriented
  • Best for workspaces, agents, tools, variables, knowledge base docs, leads, and conversations

​
V2 / legacy

Still available for older integrations that depend on legacy endpoint behavior.

​
WebSocket interact

Best when you need real-time streaming responses during a live conversation.

​
Region-specific base URLs

Pick the region that matches your workspace:

​
V3

  • EU: https://eu-gcp-api.vg-stuff.com/v3
  • NA: https://na-gcp-api.vg-stuff.com/v3

​
V2

  • EU: https://eu-cloudflare.vg-stuff.com
  • NA: https://na-cloudflare.vg-stuff.com
Using the wrong region can cause authentication failures or data mismatches.

​
Authentication

Most protected endpoints use:
You can use either:
  • A workspace secret
  • An agent secret

Get a workspace secret from the workspace selector in the dashboard.

Get an agent secret from the agent Settings page.

​
Where to go next

V3 API Intro

Start with the recommended API for new integrations.

Authentication

Learn how secrets and authorization work.

Endpoints

Review V2, V3, and WebSocket hosts by region.