Library

List your My-Library characters, each once per project.

Lists one page of the caller's My-Library characters, the read the Cast tab makes: each character ONCE per project (a script with no project counts as its own), however many episodes cast them, with every distinct looks entry (headshot, and the full-body figure when there is one) newest first. Grouped by project (the project with the newest picture first), A to Z within it. query keeps characters whose name or project name contains it; projectId (a project id or routeId) keeps one project's. total is how many characters match across every page; pass nextCursor back as cursor (with the same filters) for the next page (null on the last). projects lists every project the whole library's characters belong to, with how many each holds. Each look's id is a libraryImageId for the frame swap-from-library ops. Scope: story:read.

get/library/cast

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/library/cast
  • Auth: HTTP bearer

Query parameters

querystring

Keep characters whose name, or whose project's name, contains this (any case).

projectIdstring

Keep one project's characters: its id or routeId.

limitinteger

Characters per page (default 48, max 100).

cursorstring

Opaque cursor: the nextCursor of the previous page.

Response

Your My-Library characters, each once per project.

nextCursorstring nullable required

Pass as cursor (with the same filters) for the next page; null on the last page.

totalinteger required

How many characters match, across every page.

Changes

No recorded changes to this operation across all 1 revision of this API.