Artifacts

Generate professional script coverage for a table read artifact.

Recommended first development round once a screenplay-backed table-read artifact exists; use the report for a revision pass before finalization, pitch packaging, or later-installment work. Runs a queued, async coverage analysis of the screenplay backing this table_read artifact: logline, premise, structure, characters, dialogue, pacing, market fit, an overall score, top fixes, and comparables. Returns { reportId, status } immediately (status: "generating"). Poll GET /artifacts/{artifactId}/coverage (optionally ?reportId=<id>) until status is complete or failed. Coverage produces a separate report — it does NOT change the artifact, its revision, or its share URLs. Free-plan accounts may generate one coverage report; additional reports require an upgrade (403 plan_limit_reached). Every plan has a monthly cap on coverage reports: past it the request is refused with 403 usage_limit_reached, whose details.resetsAt says when it resets — do not retry before then. Requires Idempotency-Key. Scope: story:write.

post/artifacts/{artifactId}/coverage

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/artifacts/{artifactId}/coverage
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Customer-generated stable identifier for safe retries of idempotent POST requests.

Request body

focusPromptstring

Optional free-form lens the analysis should weave throughout (e.g. "focus on whether the second act earns its midpoint").

confirmedboolean

Omit to get the price WITHOUT running anything: the request is checked the same way and answers what a new report would use (a report costs no Studio Credits — it is metered by the plan) and starts NOTHING. Pass true only once the writer has seen that and said go.

Response

Coverage generation queued. Poll GET /artifacts/{artifactId}/coverage until terminal.

artifactIdstring required
reportIdstring required
status'generating' | 'complete' | 'failed' required

Lifecycle of an async coverage report. Poll GET /artifacts/{id}/coverage until complete or failed.

versioninteger required

Sequential coverage version for the backing script (increments per report).

Changes

No recorded changes to this operation across all 2 revisions of this API.