Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Happy Scribe Orders API

Create and track transcription, subtitling, and translation orders.

Happy Scribe Orders API is one of 7 APIs that Happy Scribe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://www.happyscribe.com/api/v1.

4 operations 4 paths 3 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://www.happyscribe.com/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Happy Scribe Orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API token from your Happy Scribe account settings, passed as Authorization: Bearer YOURAPITOKEN.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 4

Create and track transcription, subtitling, and translation orders.

POST
/orders
Create a transcription or subtitling order
createOrder body → 201401422
POST
/orders/translation
Create a translation order
createTranslationOrder body → 201401422
GET
/orders/{id}
Retrieve an order
getOrder 1 param → 200401404
POST
/orders/{id}/confirm
Confirm an incomplete order
confirmOrder 1 param → 200401404422

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are OrderInput (8 properties), Order (6 properties), Error (2 properties). Each schema is shown below with its type and property counts.

OrderInput
object
8 properties 3 required
Order
object
6 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

happyscribe-orders-api-openapi.yml Raw ↑

Other APIs Happy Scribe publishes across the network.

Happy Scribe Exports API
Happy Scribe Glossaries and Style Guides API
Happy Scribe Organization Memberships API
Happy Scribe Organizations API
Happy Scribe Transcriptions API
Happy Scribe Uploads API