Register recording

Create ready recording metadata pointing to a supplied URL for an existing scoped call.

Outcome

Create ready recording metadata pointing to a supplied URL for an existing scoped call.

Before you start

Verify the exact authenticated identity, environment and approved organization context before preparing the request.
The published application permission is workspace:write. Discover a granted canonical Voice workspace and bind its exact id. A supplied id does not grant access.
Authorize all documented effects before CLI --confirm or MCP confirm:true. Local events, canonical archival and organization erasure have distinct scope.

Discover the target

topolo whoami --json
topolo actions get app_topolo_voice.recordings.ready --detail --json
topolo resources topolo-voice --json
topolo workspaces list topolo-voice --json

Select the actual granted resource id as VOICE_WORKSPACE_ID; synthetic fixture ids authorize no live operation.
Use a real local call id retained from calls.incoming or recent granted overview. The recent call list is capped at 25; only an independently authorized organization export contains all local provider_call_id values.

Request

POST /api/recordings/ready

Save the exact action input as payload.json. Set VOICE_WORKSPACE_ID from granted canonical resource discovery. Validate it and inspect the exact path, query and body before executing.

Inspect and test this action in the signed action console.

Input fields

Field	Required	Type	Meaning and constraints
`callId`	Required	string	Existing call id in the exact granted workspace; ringing, completed and missed calls are accepted. {"minLength":1}
`artifactUrl`	Required	string	Required absolute URL accepted by the declared URL schema. Voice stores this reference; it does not fetch, validate, host or secure the remote artifact. {"format":"uri"}
`durationSeconds`	Required	integer	Required nonnegative integer duration; stored as supplied without inspecting audio. {"minimum":0}

The complete input and response schemas are available in the action console and through CLI/MCP action discovery.

Effects

Stores a new recording UUID with ready status and the remote URL reference; the associated call may be ringing, completed or missed.
Repeated requests create additional rows. It does not upload/download remote bytes, perform audio recording or prove artifact availability.
Attempts best-effort recording notification after insertion; no app outbox or delivered-recipient proof is returned.

Interpret the response

Use $.data.id for the returned recording identifier.

Examples retain complete raw Worker responses. CLI/MCP adds a transport envelope; use CLI --detail for the full result. Delegated Auth projections can vary, and the widget uses the canonical SDK contract.

Save data.id and data.callId, verify status ready and inspect workspace counts or an authorized organization export. Organization export deliberately replaces artifact_url with artifact_url_present. Ready metadata does not verify remote artifact access, contents or retention.

Worked examples

Actual worker and isolated migrated D1; synthetic Auth identity, nondefault workspace grants and archive transport. Notify and Nexus are disabled. No live telephony, remote audio or transcript hosting/deletion is tested. Refused examples explain boundaries; do not execute them as successful workflows.

minimal · Successful request · HTTP 201

Actual local worker response and migrated D1. Auth identity/grants/archive are simulated. Notify and metering are disabled; no telephony or remote audio/transcript provider is contacted. Fixture identifiers authorize no live action.

Input · payload.json:

{
  "callId": "call_399b0403-b561-498d-95aa-d8fa70c583e6",
  "artifactUrl": "https://media.example.com/fixture.wav",
  "durationSeconds": 0
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_voice.recordings.ready",
    "input": {
      "callId": "call_399b0403-b561-498d-95aa-d8fa70c583e6",
      "artifactUrl": "https://media.example.com/fixture.wav",
      "durationSeconds": 0
    },
    "resourceType": "workspace",
    "resourceId": "<id returned by granted resource discovery>",
    "confirm": true
  }
}

Captured response · HTTP 201:

{
  "data": {
    "id": "recording_83afd788-e6c8-4575-b2c2-59b20f842121",
    "callId": "call_399b0403-b561-498d-95aa-d8fa70c583e6",
    "status": "ready",
    "createdAt": "2026-10-04T07:54:39.245Z"
  }
}

HTTP 201. Save data.id and data.callId, verify status ready and inspect workspace counts or an authorized organization export. Organization export deliberately replaces artifact_url with artifact_url_present. Ready metadata does not verify remote artifact access, contents or retention.

minimal · Successful request · HTTP 201

Input · payload.json:

{
  "callId": "call_399b0403-b561-498d-95aa-d8fa70c583e6",
  "artifactUrl": "https://media.example.com/duplicate.wav",
  "durationSeconds": 1
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_voice.recordings.ready",
    "input": {
      "callId": "call_399b0403-b561-498d-95aa-d8fa70c583e6",
      "artifactUrl": "https://media.example.com/duplicate.wav",
      "durationSeconds": 1
    },
    "resourceType": "workspace",
    "resourceId": "<id returned by granted resource discovery>",
    "confirm": true
  }
}

Captured response · HTTP 201:

{
  "data": {
    "id": "recording_3ca66a56-191d-4875-bb41-8c9b870896fb",
    "callId": "call_399b0403-b561-498d-95aa-d8fa70c583e6",
    "status": "ready",
    "createdAt": "2026-10-04T07:54:39.263Z"
  }
}

minimal · Refused request · HTTP 404

Input · payload.json:

{
  "callId": "call_missing",
  "artifactUrl": "https://media.example.com/missing.wav",
  "durationSeconds": 0
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json

Captured response · HTTP 404:

{
  "error": "call_not_found"
}

HTTP 404. The actual handler refused this request. Inspect the exact cause and current state before deciding whether to retry.

workflow · Successful request · HTTP 201

Input · payload.json:

{
  "callId": "call_772a7b3c-7ee3-4295-b44a-8c4a24e47ba3",
  "artifactUrl": "https://media.example.com/fixture.wav",
  "durationSeconds": 63
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_voice.recordings.ready",
    "input": {
      "callId": "call_772a7b3c-7ee3-4295-b44a-8c4a24e47ba3",
      "artifactUrl": "https://media.example.com/fixture.wav",
      "durationSeconds": 63
    },
    "resourceType": "workspace",
    "resourceId": "<id returned by granted resource discovery>",
    "confirm": true
  }
}

Captured response · HTTP 201:

{
  "data": {
    "id": "recording_29fd1eaa-03c0-4155-a022-15e69fe3deef",
    "callId": "call_772a7b3c-7ee3-4295-b44a-8c4a24e47ba3",
    "status": "ready",
    "createdAt": "2026-10-04T07:54:40.175Z"
  }
}

workflow · Successful request · HTTP 201

Input · payload.json:

{
  "callId": "call_772a7b3c-7ee3-4295-b44a-8c4a24e47ba3",
  "artifactUrl": "https://media.example.com/duplicate.wav",
  "durationSeconds": 1
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_voice.recordings.ready",
    "input": {
      "callId": "call_772a7b3c-7ee3-4295-b44a-8c4a24e47ba3",
      "artifactUrl": "https://media.example.com/duplicate.wav",
      "durationSeconds": 1
    },
    "resourceType": "workspace",
    "resourceId": "<id returned by granted resource discovery>",
    "confirm": true
  }
}

Captured response · HTTP 201:

{
  "data": {
    "id": "recording_180e70bc-438f-4c61-8de7-95782c42e321",
    "callId": "call_772a7b3c-7ee3-4295-b44a-8c4a24e47ba3",
    "status": "ready",
    "createdAt": "2026-10-04T07:54:40.192Z"
  }
}

workflow · Refused request · HTTP 404

Input · payload.json:

{
  "callId": "call_missing",
  "artifactUrl": "https://media.example.com/missing.wav",
  "durationSeconds": 0
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json

Captured response · HTTP 404:

{
  "error": "call_not_found"
}

HTTP 404. The actual handler refused this request. Inspect the exact cause and current state before deciding whether to retry.

privacy · Successful request · HTTP 201

Input · payload.json:

{
  "callId": "call_34f3ad97-75be-4c5d-bb06-ae16acb413e9",
  "artifactUrl": "https://media.example.com/fixture.wav",
  "durationSeconds": 63
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_voice.recordings.ready",
    "input": {
      "callId": "call_34f3ad97-75be-4c5d-bb06-ae16acb413e9",
      "artifactUrl": "https://media.example.com/fixture.wav",
      "durationSeconds": 63
    },
    "resourceType": "workspace",
    "resourceId": "<id returned by granted resource discovery>",
    "confirm": true
  }
}

Captured response · HTTP 201:

{
  "data": {
    "id": "recording_011da024-ed24-4ae4-a2bc-22decd2e50ce",
    "callId": "call_34f3ad97-75be-4c5d-bb06-ae16acb413e9",
    "status": "ready",
    "createdAt": "2026-10-04T07:54:41.739Z"
  }
}

privacy · Successful request · HTTP 201

Input · payload.json:

{
  "callId": "call_34f3ad97-75be-4c5d-bb06-ae16acb413e9",
  "artifactUrl": "https://media.example.com/duplicate.wav",
  "durationSeconds": 1
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_voice.recordings.ready",
    "input": {
      "callId": "call_34f3ad97-75be-4c5d-bb06-ae16acb413e9",
      "artifactUrl": "https://media.example.com/duplicate.wav",
      "durationSeconds": 1
    },
    "resourceType": "workspace",
    "resourceId": "<id returned by granted resource discovery>",
    "confirm": true
  }
}

Captured response · HTTP 201:

{
  "data": {
    "id": "recording_c1001f8f-8427-41a5-9af2-2125dc2c8de1",
    "callId": "call_34f3ad97-75be-4c5d-bb06-ae16acb413e9",
    "status": "ready",
    "createdAt": "2026-10-04T07:54:41.766Z"
  }
}

privacy · Refused request · HTTP 404

Input · payload.json:

{
  "callId": "call_missing",
  "artifactUrl": "https://media.example.com/missing.wav",
  "durationSeconds": 0
}

CLI:

topolo actions validate app_topolo_voice.recordings.ready --data @payload.json --json
topolo actions plan app_topolo_voice.recordings.ready --resource-type workspace --resource-id "$VOICE_WORKSPACE_ID" --data @payload.json --json

Captured response · HTTP 404:

{
  "error": "call_not_found"
}

HTTP 404. The actual handler refused this request. Inspect the exact cause and current state before deciding whether to retry.

Verify the result

Save data.id and data.callId, verify status ready and inspect workspace counts or an authorized organization export.
Organization export deliberately replaces artifact_url with artifact_url_present. Ready metadata does not verify remote artifact access, contents or retention.

Errors and recovery

call_not_found (HTTP 404): The id is absent from this organization/workspace. Discover or retain the actual local call id in the approved context; supplied ids grant no access.
organization_required (HTTP 403): The authenticated request has no organization. Stop and establish the approved owning organization; supplied workspace ids do not create membership.

Auth, resource resolution and published input validation can refuse a request before its handler. Retain the actual error, request id and approved context. A plain-text HTTP 500 is surfaced by CLI/MCP as http_error; that transport code is not a structured Voice handler error.

Recovery boundary

No published individual recording update/delete or remote byte erasure exists. Resolve remote hosting or access through its actual owner. After an ambiguous response, inspect local metadata before repeating.

Get Voice workspace overview: Read all-workspace counts and the most recent 25 calls and provider failures in one granted Voice workspace.
Export Voice organization data: Read six local Voice table sets across every workspace of the authenticated organization, with remote artifact URLs redacted.

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

minimal · Successful request · HTTP 201

minimal · Successful request · HTTP 201

minimal · Refused request · HTTP 404

workflow · Successful request · HTTP 201

workflow · Successful request · HTTP 201

workflow · Refused request · HTTP 404

privacy · Successful request · HTTP 201

privacy · Successful request · HTTP 201

privacy · Refused request · HTTP 404

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence