Scority

OpenAPI Specification

Use the Scority OpenAPI specification to inspect endpoints, authentication, transcript response schemas and error codes.

Open OpenAPI JSONView API reference
Direct answer

The machine-readable API contract is openapi.json

Scority publishes a JSON OpenAPI specification for the current public API. Use it to inspect endpoint shape, authentication, transcript response schemas and error codes.

  • URL: https://api.scority.ai/openapi.json.
  • OpenAPI version: 3.1.0.
  • Security scheme: x-api-key in the request header.
  • Current public transcript endpoint: GET /v1/youtube/transcript.

Import target

OpenAPI URL:
https://api.scority.ai/openapi.json

Security scheme:
x-api-key header
Included

Endpoints covered by the spec

The specification documents the public health endpoint and the protected transcript endpoint. It intentionally leaves out private dashboard, billing and operator internals.

  • GET /health returns public API liveness information.
  • GET /v1/youtube/transcript returns transcript text and segments for authenticated requests.
  • Transcript responses include language, source, text and segments.
  • Errors use the normalized error envelope with error.code and error.message.
Tools

Import into API clients and inspectors

Postman, Insomnia, Scalar and similar tools can import the OpenAPI URL directly. Generated clients should still keep x-api-key server-side.

  • Use YOUR_API_KEY placeholders in shared examples.
  • Do not generate browser clients that embed API keys.
  • Review generated retry behavior before using it in production.
  • Regenerate clients when the OpenAPI spec changes.
Not included

What the public spec does not expose

The public OpenAPI document is intentionally narrow. It documents the working public API contract without exposing internal implementation details.

  • No dashboard, billing, account or admin routes.
  • No API key hashes, database IDs or service credentials.
  • No proxy diagnostics, caption track URLs or upstream response bodies.
  • No tools for endpoints that do not exist in the production API.
Reference

API reference

Read the human-facing endpoint reference and examples.

Open →
Auth

Authentication

Keep x-api-key in trusted server-side code.

Open →
Errors

Error codes

Map OpenAPI error schemas to integration behavior.

Open →
Node.js

Node.js guide

Use server-side fetch with the current API contract.

Open →
Python

Python guide

Call the transcript endpoint with requests.

Open →