Update a recording's Recording ID

PATCH /api/v1/workflow-recordings/{id} — request parameters and responses from the Menace Voice API schema.

2 min read

patch/api/v1/workflow-recordings/{id}

Request example

curl --request PATCH \
  --url https://voice.menaceui.com/api/v1/workflow-recordings/{id} \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>' \
  --header 'Content-Type: application/json' \
  --data '{
  "recording_id": "<string>"
}'

Response

{
  "id": 1,
  "recording_id": "<string>",
  "workflow_id": 1,
  "organization_id": 1,
  "tts_provider": "<string>",
  "tts_model": "<string>",
  "tts_voice_id": "<string>",
  "transcript": "<string>",
  "storage_key": "<string>",
  "storage_backend": "<string>",
  "metadata": {},
  "created_by": 1,
  "created_at": "2026-08-10T12:00:00Z",
  "is_active": true
}

patch/api/v1/workflow-recordings/{id}

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Path parameters

idintegerrequired#

Headers

authorizationstring · null#

X-API-Keystring · null#

Body

application/json

recording_idstringrequired#

New descriptive recording ID (letters, numbers, hyphens, underscores only)

Length: 1–64Pattern: ^[a-zA-Z0-9_-]+$

Responses

application/json

Successful Response

idintegerrequired#

recording_idstringrequired#

workflow_idinteger · null#

Show child attributes

Any of

organization_idintegerrequired#

tts_providerstring · null#

Show child attributes

Any of

tts_modelstring · null#

Show child attributes

Any of

tts_voice_idstring · null#

Show child attributes

Any of

transcriptstringrequired#

storage_keystringrequired#

storage_backendstringrequired#

metadataobjectrequired#

created_byintegerrequired#

created_atstringrequired#

is_activebooleanrequired#

Delete a recording Transcribe an audio file