HAhappyscribe
Conversations

Update a conversation

Updates an existing conversation: rename it, move it to another folder in the same workspace, and/or toggle link sharing — any combination in one request.

Set sharing_enabled: true and read public_url from the response to get the public link; set it to false to revoke public access.

patch/conversations/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Path parameters

idstring required
Example:e458099e7f8da14f9625854ba7b6a026917ad306

ID of the conversation.

Request body

Example request

{
  "conversation": {
    "workspace_id": "wks_01k6a2r9s8x7c2dvq3m5n6p4ab"
  }
}

Response

The updated conversation.

idstring

Unique identifier of the conversation.

namestring
created_atstring date-time
updated_atstring date-time
state'initial' | 'ingesting' | 'automatic_transcribing' | 'automatic_done' | 'aligning' | 'locked' | 'failed' | 'demo'

Current processing state:

  • initial — waiting to be processed
  • ingesting — media file is being ingested
  • automatic_transcribing — audio is being transcribed to text
  • automatic_done — finished and ready to export
  • aligning — text is being realigned with the audio
  • locked — locked due to insufficient credits
  • failed — file failed to process
  • demo — the initial demo file
sharing_enabledboolean

true when "Anyone with the link" is enabled.

public_urlstring nullable

Public, no-login URL to share when sharing_enabled is true; null while sharing is disabled.

languagestring

BCP-47 language code.

audio_length_in_secondsnumber
cost_in_centsinteger
refundedboolean
tagsstring[]
delivery_estimated_atstring date-time

Estimated delivery time. It can change over time.

failure_reasonstring nullable

Error code for the failure.

failure_messagestring nullable

User-friendly message explaining the failure root cause.

soundwave_urlstring nullable

Soundwave in BBC audiowaveform binary format. Available once the state is automatic_done.

audio_urlstring nullable

Short-lived signed URL to the transcoded MP3. Present once transcoded; fetch fresh rather than caching.

video_urlstring nullable

Short-lived signed URL to the transcoded MP4. Present for video conversations once transcoded.

Example response

{
  "id": "e458099e7f8da14f9625854ba7b6a026917ad306",
  "name": "interview1.mov",
  "folder": {
    "id": 521,
    "name": "Marketing interviews"
  },
  "created_at": "2024-10-29T14:31:29.799Z",
  "updated_at": "2024-10-29T14:31:38.495Z",
  "state": "automatic_done",
  "sharing_enabled": false,
  "language": "en-GB",
  "audio_length_in_seconds": 42,
  "cost_in_cents": 100,
  "refunded": false,
  "tags": [
    "To do",
    "req_1234"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.