Skip to content

List Session Runs

GET
/v1/sessions/{session_id}/runs
curl --request GET \
--url 'https://agents.lumalabs.ai/v1/sessions/example/runs?limit=25' \
--header 'Authorization: Bearer <token>'

Keyset-paginated list of this session's runs, newest first. See list_scopes.

session_id
required
Session Id
string
limit
Limit
integer
default: 25 >= 1 <= 100
cursor
Any of:
string

Opaque token from a previous page's next_cursor.

Successful Response

Media typeapplication/json
ListRunsResponse

Keyset-paginated run list (GET /v1/sessions/{id}/runs). See ListScopesResponse.

object
data
required
Data
Array<object>
RunResponse

One run as a caller reads it — the single handle and the single wait.

object
app
Any of:
string
completed_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
error
Any of:
object
key
additional properties
any
kind
required
RunKind

What kind of work a run performs. Mirrors db.ApiRunKind.

string
Allowed values: brief generate capability
outputs
Outputs

Assets this run produced.

Array<object>
RunOutput

One asset a run produced. The durable handle is asset_id.

object
asset_id
Any of:
string
layer
Any of:
OutputLayer

One layer of a layering output.

object
alpha_hint
required
Alpha Hint

Edge treatment of the layer's transparency — soft (hair/fur/glass), hard (solid edges), or none (the opaque background).

string
Allowed values: soft hard none
bounds
OutputLayerBounds

Placement of this layer's pixels within the composite canvas. Absent only when the output's dimensions could not be resolved.

object
canvas_height
required
Canvas Height

Height of the full composite canvas the layers reassemble into.

integer
canvas_width
required
Canvas Width

Width of the full composite canvas the layers reassemble into.

integer
height
required
Height

Pixel height of the returned layer image.

integer
width
required
Width

Pixel width of the returned layer image.

integer
x
required
X

Left offset of this layer's pixels within the composite canvas.

integer
y
required
Y

Top offset of this layer's pixels within the composite canvas.

integer
contains_text
Contains Text

Whether the layer was planned as typeset text (a headline, caption, or label) rather than an image element. Absent when not reported for this output.

boolean
description
required
Description

Complete-element caption for the layer's content.

string
index
required
Index

Layer position, front-to-back; the last layer is the background.

integer
label
required
Label

Short (1-2 word) layer name.

string
text
OutputLayerText

The text read off a contains_text layer, so it can be re-typeset as live text inside bounds. Absent when the layer holds no text, or its lettering could not be read or is a logo / wordmark. Final whenever the job is. A layering job is not reported finished until reading its text has finished or timed out.

object
content
required
Content

The text as shown, preserving capitalization, with a line break between lines.

string
decorated
required
Decorated

True when the lettering is ornamental (outlines, patterned fills, bevels, drop shadows), so plain typeset text will not reproduce its look.

boolean
font
OutputLayerFont

Described typeface traits. Absent when they could not be read.

object
category
required
Category

Letterform style.

string
Allowed values: sans serif serif slab serif display sans display serif display slab display decorative handwriting monospace
families
required
Families

Up to three Google Fonts family names that resemble the lettering, closest first. Empty when none of the offered families fit.

Array<string>
italic
required
Italic

Whether the letters are slanted or cursive.

boolean
match
OutputLayerFontMatch

The font in your font catalog that the lettering matches, so you can re-set the text in it. Absent when no catalog font matches closely enough, or matching is not enabled. The image itself is not rendered in this font.

object
face_id
required
Face Id

Typed ref of the matched face (one weight and style), font_face:, as typeset actions take it.

string
family_id
required
Family Id

Typed ref of the matched font family, font_family:.

string
family_name
required
Family Name

Name of the matched font family.

string
style
required
Style

Style of the matched face.

string
Allowed values: normal italic
weight
required
Weight

CSS font weight of the matched face, e.g. 400 or 700.

integer
weight
required
Weight

Stroke weight.

string
Allowed values: thin light regular medium bold black
width
required
Width

Letter width for its height.

string
Allowed values: condensed normal wide
mime
Any of:
string
type
Any of:
string
url
Any of:
string
key
additional properties
any
pending
Any of:
object
key
additional properties
any
replayed
Replayed

True when this idempotency_key had already started a run: that run is echoed and no second one was started.

boolean
result
Any of:
object
key
additional properties
run_id
required
Run Id
string
session_id
required
Session Id
string
settled_with
Any of:
string
state
required
RunState

A run's lifecycle state. Mirrors db.ApiRunState.

string
Allowed values: queued running needs_input blocked completed failed cancelled
summary
Any of:
string
turn_id
Any of:
string
updated_at
required
Updated At
string format: date-time
has_more
required
Has More
boolean
next_cursor
Any of:
string
Example
{
"data": [
{
"kind": "brief",
"outputs": [
{
"layer": {
"alpha_hint": "soft",
"text": {
"font": {
"category": "sans serif",
"match": {
"style": "normal"
},
"weight": "thin",
"width": "condensed"
}
}
}
}
],
"replayed": false,
"state": "queued"
}
]
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}