Skip to main content
GET
Read an HRI preset

Authorizations

X-API-Key
string
header
required

Path Parameters

preset_id
string
required

Preset id (UUID or 22-char shortuuid).

Response

OK

A saved HRI configuration.

id
string
required

Preset id (22-char shortuuid). Use in /hri-presets/{id}/ paths.

name
string
required

Human-readable preset name, unique among the org's non-archived presets.

options
HRIOptions · object
required

The saved HRI configuration — the same model the API accepts inline.

Example:
is_default
boolean
required

Applied by generation endpoints when no HRI options or named preset are supplied.

version
integer
required

Bumps whenever options changes.

is_archived
boolean
required

Archived presets are hidden from selection but keep their history.

created
string<date-time>
required

Creation timestamp (ISO-8601).

modified
string<date-time>
required

Last-modified timestamp (ISO-8601).