Orders

Get order status

Retrieve the current status of an order. While it is being edited: the step, percentage and estimated seconds remaining. When done: each file with its kind and a download link, what the edit changed, and what is not included and why. When failed: why, and what to do next.

get/orders/{id}

Request

  • Base URL: https://barevalue.com/api/v1
  • URL: https://barevalue.com/api/v1/orders/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Order ID

Response

Order details

order_idinteger
status'new' | 'submitted' | 'in_progress_submitted' | 'done' | 'failed' | 'canceled'

new: accepted and not yet placed, its file is being fetched and measured (usually under a minute, several minutes when the fetch is retried); ask again after retry_after_seconds. submitted and in_progress_submitted: being edited. done: files ready. failed: see failure

typestring
podcast_namestring nullable
episode_namestring nullable
episode_numberstring nullable
duration_minutesnumber nullable
costnumber
credits_usednumber
submitted_atstring date-time nullable
completed_atstring date-time nullable
retry_after_secondsinteger

While the order is new (its file is being fetched) or being edited: when to ask again. Also sent as the Retry-After header

Example response

{
  "type": "audio_editing_ai_only",
  "downloads": [
    {
      "format": "mp3"
    }
  ],
  "summary": {
    "changes": [
      "Enhanced audio quality",
      "Made 2 requested edits",
      "Trimmed awkward pauses"
    ],
    "cuts": 142,
    "seconds_removed": 197.7,
    "duration_before_seconds": 2698.4,
    "duration_after_seconds": 2500.9
  }
}

Changes

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