v1 - Live

Capsiynau REST API

Integrate Welsh captioning into your product. Every request requires an API key.

Authentication

Pass your key in the Authorization header:

Authorization: Bearer ck_live_YOUR_KEY

# Or via X-API-Key header
X-API-Key: ck_live_YOUR_KEY

Rate limit: 60 req/min. Returns 429 when exceeded. Headers: X-RateLimit-Remaining, X-RateLimit-Reset.

Official SDKs

Skip raw HTTP - use the official Node SDK:

npm install @capsiynau/sdk-transcribe

import { TranscriptionClient } from '@capsiynau/sdk-transcribe'
const client = new TranscriptionClient({ apiKey: process.env.CAPSIYNAU_API_KEY })

const job = await client.submit({ projectId, fileUrl, language: 'cy' })
await client.waitFor(job.jobId)
const transcript = await client.getTranscript(job.projectId)
console.log(transcript.segments[0].text)

The SDK parses errors into typed classes (AuthError, PlanGateError, QuotaError, and more) and tracks job status correctly.

Endpoints

Error Codes

200Success
201Created
400Bad request - missing or invalid parameter
401Invalid or revoked API key
404Resource not found
429Rate limit exceeded - retry after 60 s
500Internal server error

Get an API Key

Available on Pro and Studio plans. Create a key in your account settings.

Account Settings