Try it uses test keys only. Requests go straight from your browser to https://voice-api.relationsai.com/v1 with a rai_test_ key, which never places a real call. It works once the API is enabled for your workspace (private preview: support@relationsai.com). Your key stays in this tab's memory; live keys are refused.

Workspace

Download schema

The workspace and API key a request is authenticated as, and what they can do.

Retrieve the workspace

GET

https://voice-api.relationsai.com/v1

/workspace

Bearer (rai_test_... or rai_live_...)

Returns the workspace your API key belongs to, the key itself (name, mode, scopes, expiry), what the workspace can do through the API (capabilities) and the limits that apply (limits).

Call this first: it is the quickest way to check that a key works, which mode it is in and which scopes it has. It needs no scope beyond the workspace:read scope every key has, and it never changes anything.

GET /v1/workspace · Operation ID: getWorkspace

Retrieve the workspace › Responses

The workspace, the current key, capabilities and limits.

The workspace the API key belongs to, the key itself, and what the workspace can do through the API in the key's mode. Call it first to check a key, its scopes and its limits.

Workspace

id

string · pattern: ^ws_[A-Za-z0-9_-]{1,… · required

Workspace id (ws_...).

object

string · const · required

Always workspace.

Const value: workspace

livemode

boolean · required

true when the key is a live key, false for a test key.

name

string · required

Workspace name as shown in the console.

timezone

string · required

IANA timezone of the workspace. Calling hours (if enabled in the console) are evaluated in it.

Example: Asia/Kolkata

currency

string · pattern: ^[A-Z]{3}$ · required

Currency calls are charged in (ISO 4217). Open enum; today always INR.

WorkspaceApiKey · required

The API key this request was authenticated with. The secret itself is never returned.

WorkspaceCapabilities · required

What this workspace can do through the API. A false here means the feature is not offered today, so a client can adapt instead of discovering it from errors.

WorkspaceLimits · required

Limits that apply to this key and workspace in the key's mode.

GET/workspace

curl -X GET https://voice-api.relationsai.com/v1/workspace \
     -H "Authorization: Bearer <token>"

Example Responses

{
  "id": "ws_7Hk2Lm9QxR4tB8vN3cZp6W",
  "object": "workspace",
  "livemode": false,
  "name": "Acme Lending",
  "timezone": "Asia/Kolkata",
  "currency": "INR",
  "api_key": {
    "id": "key_4Nf8Gt2Hx6Jq9Lm3Pv7Rs1",
    "name": "CRM sync (test)",
    "environment": "test",
    "scopes": [
      "workspace:read",
      "agents:read",
      "numbers:read",
      "calls:read",
      "calls:write",
      "transcripts:read",
      "recordings:read",
      "analysis:read"
    ],
    "created_at": "2026-10-20T08:15:00.000Z",
    "expires_at": null
  },
  "capabilities": {
    "campaign_pause": true,
    "campaign_resume": true,
    "call_ringing_status": false,
    "live_transcript": false,
    "sentiment_analysis": false,
    "end_call": false,
    "agent_editing": false,
    "inbound_calls": false,
    "webhooks": true
  },
  "limits": {
    "rate_limits": {
      "read": {
        "per_key_per_minute": 600,
        "per_workspace_per_minute": 1200
      },
      "write": {
        "per_key_per_minute": 120,
        "per_workspace_per_minute": 240
      },
      "dial": {
        "per_key_per_minute": null,
        "per_workspace_per_minute": 30
      }
    },
    "daily_call_limit": null,
    "campaign_max_concurrency": 10
  }
}

json

application/json

Agents