Skip to main content
GET
Get a composition act by ID

Authorizations

X-Api-Key
string
header
required

Your team API key (starts with al_live_).

Headers

Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-07-16 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-16"

Path Parameters

id
string
required

Composition-act id from GET /v1/actions.

Example:

"3f2b6c1e-8a4d-4e2b-9c7a-1d5e8f0a2b3c"

Response

Composition act details

id
string<uuid>
required

Composition-act identifier — pin via action_id on POST /v1/images.

Example:

"3f2b6c1e-8a4d-4e2b-9c7a-1d5e8f0a2b3c"

name
string
required

Display name.

Example:

"Over-the-shoulder"

supported_character_counts
number[]
required

Subject counts this act supports. Pin with a matching number of subjects; an unsupported count returns 400 action_not_available. Empty only transiently.

Example:
description
string | null

What the act does.

preview_url
string | null

A signed preview image URL served by the API (GET /v1/actions/{id}/preview), short-lived (~1h) and re-minted every time you list the catalog. The bytes stream through the API — it is never a raw storage path or a link to the storage provider. Fetch it fresh rather than storing it. null when the act has no preview image.