Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
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.
openapi: 3.2.0
info:
title: Scribiz Service API
version: 1.0.0
description: 'Operations tagged Service across 2 of this provider''s published API definitions: openapi.json, scribiz-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: 'The one public base for every client: https://scribiz.com/api (Better Auth at /api/auth, remote MCP at https://scribiz.com/mcp). The proxy routes both paths to this API.'
url: https://scribiz.com/api
tags:
- name: Service
paths:
/health:
get:
operationId: health
responses:
'200':
content:
application/json:
schema:
properties:
ok:
const: true
type: object
description: Alive.
summary: Liveness
tags:
- Service
servers:
- description: 'The one public base for every client: https://scribiz.com/api (Better Auth at /api/auth, remote MCP at https://scribiz.com/mcp). The proxy routes both paths to this API.'
url: https://scribiz.com/api
/v1/openapi.json:
get:
operationId: openapi
responses:
'200':
content:
application/json:
schema:
type: object
description: This document.
summary: The OpenAPI document
tags:
- Service
servers:
- description: 'The one public base for every client: https://scribiz.com/api (Better Auth at /api/auth, remote MCP at https://scribiz.com/mcp). The proxy routes both paths to this API.'
url: https://scribiz.com/api
/v1/status:
get:
description: Queue depth, success rate per source over the last day, and whether the free Listen/Watch tier is paused.
operationId: status
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
description: Status.
summary: Service status
tags:
- Service
servers:
- description: 'The one public base for every client: https://scribiz.com/api (Better Auth at /api/auth, remote MCP at https://scribiz.com/mcp). The proxy routes both paths to this API.'
url: https://scribiz.com/api
components:
schemas:
Status:
properties:
free_tier:
properties:
listen_watch:
enum:
- open
- paused
type: object
notes:
description: What is working through a fallback, in words (for example results that came from captions or a direct read of the link because the platform blocks downloads from this server).
items:
type: string
type: array
ok:
const: true
queue:
properties:
capacity:
type: integer
queued:
type: integer
running:
type: integer
type: object
sources:
description: 'Per source over the window: jobs, succeeded, failed, blocked (failed because the platform refused), fallback (succeeded through captions or a direct read of the link after the platform blocked the download: a success with a note), success_rate, avg_seconds.'
items:
type: object
type: array
status:
enum:
- operational
- degraded
time:
type: integer
window_hours:
type: integer
required:
- ok
- status
- queue
- sources
type: object
securitySchemes:
apiKey:
description: 'An API key (sbz_live_...), as X-API-Key. Keys are made in the dashboard or by `scribiz login`. Each key has one scope, named in an operation''s security requirement. `all`: Everything a key can do: start jobs, upload, ask, cancel, the Gemini proxy and listing keys. Includes read. `mcp`: The remote MCP server at /mcp. Includes read. `read`: Read jobs and their events.'
in: header
name: X-API-Key
type: apiKey
x-scopes:
all: 'Everything a key can do: start jobs, upload, ask, cancel, the Gemini proxy and listing keys. Includes read.'
mcp: The remote MCP server at /mcp. Includes read.
read: Read jobs and their events.
bearer:
description: 'An API key (sbz_live_...) or a session token from the device flow. Each key has one scope, named in an operation''s security requirement. `all`: Everything a key can do: start jobs, upload, ask, cancel, the Gemini proxy and listing keys. Includes read. `mcp`: The remote MCP server at /mcp. Includes read. `read`: Read jobs and their events. A session token has every scope.'
scheme: bearer
type: http
x-scopes:
all: 'Everything a key can do: start jobs, upload, ask, cancel, the Gemini proxy and listing keys. Includes read.'
mcp: The remote MCP server at /mcp. Includes read.
read: Read jobs and their events.
cookie:
description: The browser session (same-origin /api/*).
in: cookie
name: better-auth.session_token
type: apiKey
x-refined-from:
- openapi.json
- scribiz-openapi.json