Happy Scribe Orders API
Create and track transcription, subtitling, and translation orders.
Create and track transcription, subtitling, and translation orders.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/happyscribe-orders-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Happy Scribe Orders API
description: The Happy Scribe API turns audio and video into text and subtitles programmatically.
version: '1.0'
contact:
name: Happy Scribe
url: https://dev.happyscribe.com
servers:
- url: https://www.happyscribe.com/api/v1
description: Happy Scribe API v1
security:
- bearerAuth: []
tags:
- name: Orders
description: Create and track transcription, subtitling, and translation orders.
paths:
/orders:
post:
operationId: createOrder
tags:
- Orders
summary: Create a transcription or subtitling order
description: Creates an order to transcribe or subtitle a media file from a URL, using automatic (machine) or professional (human) service. This is the preferred way to submit new work.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrderInput'
responses:
'201':
description: The created order.
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/ValidationError'
/orders/translation:
post:
operationId: createTranslationOrder
tags:
- Orders
summary: Create a translation order
description: Creates an order to translate an existing transcription into a target language.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- transcription_id
- target_language
properties:
transcription_id:
type: string
target_language:
type: string
description: BCP-47 target language code.
service:
type: string
enum:
- auto
- pro
responses:
'201':
description: The created translation order.
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/ValidationError'
/orders/{id}:
parameters:
- $ref: '#/components/parameters/Id'
get:
operationId: getOrder
tags:
- Orders
summary: Retrieve an order
description: Retrieves an order by ID, including its state.
responses:
'200':
description: The requested order.
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/orders/{id}/confirm:
parameters:
- $ref: '#/components/parameters/Id'
post:
operationId: confirmOrder
tags:
- Orders
summary: Confirm an incomplete order
description: Confirms an order that was created in an incomplete state, submitting it for processing.
responses:
'200':
description: The confirmed order.
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/ValidationError'
components:
schemas:
Error:
type: object
properties:
error:
type: string
message:
type: string
Order:
type: object
properties:
id:
type: string
state:
type: string
enum:
- incomplete
- waiting_for_payment
- submitted
- locked
- fulfilled
- failed
- canceled
- expired
service:
type: string
language:
type: string
transcription_ids:
type: array
items:
type: string
createdAt:
type: string
format: date-time
OrderInput:
type: object
required:
- url
- language
- organization_id
properties:
url:
type: string
format: uri
description: Public or signed URL of the media file.
language:
type: string
description: BCP-47 language code.
organization_id:
type: string
service:
type: string
enum:
- auto
- pro
is_subtitle:
type: boolean
default: false
confirm:
type: boolean
description: When true, submit immediately instead of leaving the order incomplete.
glossary_ids:
type: array
items:
type: string
style_guide_id:
type: string
responses:
Unauthorized:
description: Missing or invalid Bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: The requested resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
ValidationError:
description: The request payload failed validation.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
parameters:
Id:
name: id
in: path
required: true
description: The unique identifier of the resource.
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'API token from your Happy Scribe account settings, passed as `Authorization: Bearer YOUR_API_TOKEN`.'