Skip to main content
GET
List environment publication history

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

resourceType
enum<string>
required

Type of resource the environment belongs to. Only prompt (a canvas) is supported. Resource type an environment is attached to. Only canvases (prompt) are supported today.

Available options:
prompt
resourceId
string<uuid>
required

Canvas (prompt) ID.

envName
string
required

Environment name (production or a custom name). Environment name. Lowercase letters, digits and single hyphens between segments (no leading, trailing or consecutive hyphens), at most 64 characters. Leading/trailing whitespace is trimmed before validation.

production is the system environment every canvas has; it is the only reserved name you can publish to. The names production, promoted, latest and draft are reserved and cannot be used for custom environments, and a custom name cannot be a UUID.

The same rules apply to the environment_name field of POST /v2/chat/completions, which runs the version currently published to that environment of the given canvas_id (environment_name cannot be combined with version_id or application_id, and returns 404 when the environment does not exist or has no published version).

Maximum string length: 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"staging"

limit
integer
default:20

Page size. Defaults to 20, clamped to 1–100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip. Defaults to 0.

Required range: x >= 0

When true, meta.links are returned as objects ({ limit, offset, ...filters }) instead of query strings.

Response

Paginated publication history

data
object[]
required
meta
object
required