Skip to content
Back to developer docs
API reference · v1.0.0

Lyric Scoring API Reference

OpenAPI 3.0 reference for every endpoint on the Scoring API. Download the raw spec to generate your own client in the language of your choice.

Download openapi.jsonOpen in ReDocOpen in Swagger Editor
Authentication

Every request requires a Bearer token with a Professional-tier API key. Provision one at /account/api-keys.

Authorization: Bearer sfai_live_a1b2c3d4e5f6…
Endpoints
POST/api/v1/scorescoreSync

Score lyrics synchronously

Submit lyrics and wait for the full 12-metric result (30-60s typical). For batch workloads prefer /score/async.

Request body

ScoreRequest

Responses

200400401429502
POST/api/v1/score/asyncscoreAsync

Enqueue a scoring job

Returns 202 with a job id. Poll /score/jobs/{id} OR supply a webhookUrl and receive a POST when the job completes.

Request body

AsyncScoreRequest

Responses

202400401429
GET/api/v1/score/jobs/{id}scoreJobStatus

Fetch async job status + result

On first GET of a queued job by the owning key, runs the eval inline and returns the terminal result. Subsequent GETs return the cached row.

Request body

none

Responses

200403404

Full component schemas + error enums are in the raw openapi.json. For the narrative docs (curl / Node examples / async pattern), see /developer.