Assets

List the characters in your asset library

A character is a named set of images saved in the same library, kept in the order arranged in the console. It references those assets instead of copying them: deleting a character never deletes its images, and deleting an image removes it from every character. Characters are created and edited in the console; this API only reads them.

The key decides the library exactly as for GET /api/v1/assets. Each image is an asset with its stable uri (spicy://a/<id>), usable in generation requests made with keys of the same workspace, and a private previewUrl signed for at most 20 minutes. cover is the cover image (null while the character has no images).

Newest first, one page at a time: pass the previous page's nextCursor as cursor. Pass assetId to list only the characters that contain that asset. Responses are private, no-store; reading characters shares the limit of 60 requests per minute per account with reading assets.

get/api/v1/assets/entities

Request

  • Base URL: https://api.spicyapi.ai
  • URL: https://api.spicyapi.ai/api/v1/assets/entities
  • Auth: HTTP bearer

Query parameters

kind'character'

Only character exists today; omitting it means character.

assetIdstring

Only characters that contain this asset.

cursorstring
limitinteger

Response

One page of characters.

code200 required
msg'success' required
request_idstring required

Correlation identifier. Include it in support requests.

Changes

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