Label a call

PATCH/v1/calls/{call_id}Needs an API key

Set or clear one of your organization's calls' label.

Send {"label": null} to clear it. Find labelled calls with GET /v1/calls?label=.... Read-only keys answer 403.

Path parameters

call_idstringRequired

The call's ID.

Request body

What to change on a call.

labelstringRequired

The call's new label, or null to clear it.

1 to 100 characters.

Response

The call, with its new label. A call, without its output.

idstring

The call's ID. Read the call again with GET /v1/calls/{call_id}.

toolstring

The tool called.

statusstring

pendingWhile providers are tried.

succeededOnce one served the call.

failedWhen none did.

failure_reasonstring· nullable

Why a failed call was not served. Null unless the call failed.

all_attempts_failedNo provider served it.

billed_provider_failureThe provider failed the call and billed it, so no other was tried.

rate_limitedEvery provider tried refused it for its rate limit; retry later.

deadline_exceededThe call ran out of time.

internal_errorNo provider served it.

abandonedThe call ran out of time.

providerstring· nullable

The provider that served the call. Null unless the call succeeded.

requested_providerstring· nullable

The provider the request named in provider. Null when it named none.

inputobject

The input as you sent it.

resolved_inputobject

The input as the tool read it: case-insensitive values lowercased, defaults filled in, and a page token as its provider issued it.

requirearray of string

The optional outputs the request required, by name.

costobject· nullable

What the call was charged, in USD. All zeros for a failed call, unless it failed billed_provider_failure. Null while the call is pending.

cost.provider_usdstring

The data provider's part of total_usd.

cost.platform_fee_usdstring

Voxoria's part of total_usd.

cost.total_usdstring

What the call cost you, drawn from your balance: the sum of the other two.

labelstring· nullable

The name you gave the call. Null when it has none.

created_atstring

When the call was made.

Format date-time.

completed_atstring· nullable

When the call succeeded or failed. Null while it is pending.

Format date-time.

400Refused request body

The request was refused.

401INVALID_AUTH_TOKENRefused request body

The API key is missing, wrong or revoked.

403Refused request body

The key's scope does not permit changes.

404MODEL_NOT_FOUNDRefused request body

Your workspace has no call with this ID.

422VALIDATIONInvalid request body

The request is not valid.

429RATE_LIMITEDRefused request body

Too many requests with this API key.

Retry-After: Seconds until the limit resets.

curl -X PATCH https://api.voxoria.ai/v1/calls/tcall_8xQ2vT7mKpR4nW9cYb3LdE \
  -H "Authorization: Bearer $VOXORIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"weekly-rankings"}'

import os

import httpx

response = httpx.patch(
    "https://api.voxoria.ai/v1/calls/tcall_8xQ2vT7mKpR4nW9cYb3LdE",
    headers={"Authorization": f"Bearer {os.environ['VOXORIA_API_KEY']}"},
    json={"label": "weekly-rankings"},
)
print(response.json())

const response = await fetch("https://api.voxoria.ai/v1/calls/tcall_8xQ2vT7mKpR4nW9cYb3LdE", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.VOXORIA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"label": "weekly-rankings"}),
});
console.log(await response.json());

{
  "name": "label_call",
  "arguments": {
    "call_id": "tcall_8xQ2vT7mKpR4nW9cYb3LdE",
    "label": "weekly-rankings"
  }
}

200 OKResponseapplication/json

{
  "id": "tcall_8xQ2vT7mKpR4nW9cYb3LdE",
  "tool": "google.serp.organic",
  "status": "succeeded",
  "failure_reason": null,
  "provider": "example-provider",
  "requested_provider": null,
  "input": {
    "query": "crm for small teams",
    "country": "gb"
  },
  "resolved_input": {
    "query": "crm for small teams",
    "country": "gb",
    "language": "en",
    "device": "desktop",
    "page": 1,
    "autocorrect": true
  },
  "require": [],
  "cost": {
    "provider_usd": "0.02",
    "platform_fee_usd": "0.0014",
    "total_usd": "0.0214"
  },
  "label": "weekly-rankings",
  "created_at": "2026-01-05T09:00:00Z",
  "completed_at": "2026-01-05T09:00:02Z"
}