> ## Documentation Index
> Fetch the complete documentation index at: https://docs.convocore.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Started

> Use the Convocore V3 REST API to manage workspaces, agents, tools, variables, knowledge base documents, and conversations.

<Info>
  V3 is the recommended Convocore API for new integrations.
</Info>

## Base URLs

Your workspace lives in either the `EU` or `NA` region. Use the base URL that matches your dashboard region.

### EU

`https://eu-gcp-api.vg-stuff.com/v3`

### NA

`https://na-gcp-api.vg-stuff.com/v3`

<Warning>
  If you use the wrong region, requests may fail or return data from the wrong environment.
</Warning>

## Authentication

Most V3 endpoints use a standard Bearer token:

```bash theme={null}
Authorization: Bearer YOUR_SECRET_KEY
```

You can authenticate with either:

* Your **workspace secret** for workspace-level operations
* Your **agent secret** for agent-specific operations

<Frame caption="Get a workspace secret from the workspace switcher in the dashboard.">
  <img src="https://i.ibb.co/XjVNjdV/Untitled.jpg" />
</Frame>

<Frame caption="Get an agent secret from the agent Settings page.">
  <img src="https://i.ibb.co/vY8CbgL/Capture.png" />
</Frame>

## What V3 covers

The V3 API is organized around the main product objects:

* `Workspaces`
* `Agents`
* `Tools`
* `Variables`
* `Knowledge Base`
* `Leads`
* `Conversations`
* `Calls & Numbers`
* `Campaigns`
* `Custom Metrics`

Use the sidebar to jump directly into any resource group.

## Region-aware request example

```bash theme={null}
curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/agents \
  --header "Authorization: Bearer YOUR_SECRET_KEY"
```

## Choosing between API surfaces

* Use **V3 REST** when you want a stable, Bearer-authenticated HTTP API.
* Use **V2 / legacy endpoints** only if you are maintaining an older integration that already depends on them.
* Use **WebSocket interact** when you need real-time streaming behavior during live conversations.

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="shield-halved" href="/api-reference/authentication">
    Learn how secrets work and how to authorize requests safely.
  </Card>

  <Card title="Endpoints & Regions" icon="server" href="/api-reference/endpoints">
    Review all available API base URLs, including V2, V3, and WebSocket endpoints.
  </Card>
</CardGroup>