--- title: Start Run | Luma Agents --- POST /v1/sessions/{session\_id}/runs Select code samplecURL (shell:curl) ```js const url = 'https://agents.lumalabs.ai/v1/sessions/example/runs'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"aspect_ratio":"4:5","kind":"generate","model":"uni-1","prompt":"a white running shoe on an orange gradient, studio light","type":"image"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```sh curl --request POST \ --url https://agents.lumalabs.ai/v1/sessions/example/runs \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "aspect_ratio": "4:5", "kind": "generate", "model": "uni-1", "prompt": "a white running shoe on an orange gradient, studio light", "type": "image" }' ``` - Productionagents.lumalabs.ai/v1/sessions/{session\_id}/runs Start a run on this session. 202 with the handle to await. The body is discriminated on `kind` — `brief`, `generate` and `capability` all answer with the same handle. ## Authorizations - **[BearerAuth](/api/agents/index.md#bearerauth)** ## Parameters ### Path Parameters **session\_id** required *Session Id* string ### Header Parameters **Idempotency-Key** Any of: - [string](#tab-panel-0-0) - [null](#tab-panel-0-1) string <= 255 characters null ## Request Bodyrequired Media typeapplication/json One of: discriminator: kind - [StartBriefRunRequest](#tab-panel-1-0) - [StartGenerateRunRequest](#tab-panel-1-1) - [StartCapabilityRunRequest](#tab-panel-1-2) One of: - [StartBriefRunRequest](#tab-panel-2-0) - [StartBriefRunRequest](#tab-panel-2-1) *StartBriefRunRequest* Brief the session's agent, as a run. `content` works for every session. `input` is the structured spelling for an app-bound session whose app declares typed run intake. object **asset\_ids** *Asset Ids* Workspace assets to hand the agent: a prior run's output or an upload in this session's scope, by asset\_id. Array\ default: <= 20 items **attachment\_ids** *Attachment Ids* Ids of attachments already uploaded to this session. Array\ default: <= 20 items **content** required string **context\_refs** *Context Refs* Things of your team for the session's agent to follow on this message and the work it orders, each by the id its own list prints: brand\_kit: from GET /v1/brand-kits. Up to 4. Each is read as the message is sent, and what it says — a brand kit's palette, typefaces, rules and files — is stored ahead of your words as part of the message. One this team cannot read is not found. Naming the same kit again is how a session picks up an edit; a kit it already holds unchanged is named but not repeated. Array\ default: <= 4 items **idempotency\_key** Any of: - [string](#tab-panel-3-0) - [null](#tab-panel-3-1) string <= 255 characters null **input** null **kind** *Kind* string default: brief Allowed value: brief *StartBriefRunRequest* Brief the session's agent, as a run. `content` works for every session. `input` is the structured spelling for an app-bound session whose app declares typed run intake. object **asset\_ids** *Asset Ids* Workspace assets to hand the agent: a prior run's output or an upload in this session's scope, by asset\_id. Array\ default: <= 20 items **attachment\_ids** *Attachment Ids* Ids of attachments already uploaded to this session. Array\ default: <= 20 items **content** null **context\_refs** *Context Refs* Things of your team for the session's agent to follow on this message and the work it orders, each by the id its own list prints: brand\_kit: from GET /v1/brand-kits. Up to 4. Each is read as the message is sent, and what it says — a brand kit's palette, typefaces, rules and files — is stored ahead of your words as part of the message. One this team cannot read is not found. Naming the same kit again is how a session picks up an edit; a kit it already holds unchanged is named but not repeated. Array\ default: <= 4 items **idempotency\_key** Any of: - [string](#tab-panel-4-0) - [null](#tab-panel-4-1) string <= 255 characters null **input** required object **kind** *Kind* string default: brief Allowed value: brief *StartGenerateRunRequest* One-shot generation as a run on this session. The run dispatches one generation through the session, gated by the session's model grant, with no agent turn. A third-party model also takes `duration`, `medias` and `parameters`. The output lands in the session's workspace, so a later run can name it by `asset_id`. It is recorded in the session's history when it starts and when it ends, so a later brief can refer to it. It may start while a brief, a capability or another generate run is open on the session. The session names the workspace this run writes to. A body field that tries to redirect the output elsewhere is dropped, not honoured — that is how an asset ends up somewhere the caller cannot list. object **aspect\_ratio** Any of: - [string](#tab-panel-5-0) - [null](#tab-panel-5-1) string null **context\_refs** *Context Refs* Things of your team this one output follows, each by the id its own list prints: brand\_kit: from GET /v1/brand-kits. Up to 4. A brand kit's palette, typefaces and rules go ahead of your prompt, and as many of its logo, product, reference and backdrop files as this model has reference slots are attached after whatever you sent, which uses those slots. One your team cannot read is not found; one that cannot be applied to this call is refused, saying what to do about it. Array\ default: <= 4 items **duration** Any of: - [number](#tab-panel-6-0) - [null](#tab-panel-6-1) number \> 0 null **idempotency\_key** Any of: - [string](#tab-panel-7-0) - [null](#tab-panel-7-1) string <= 255 characters null **image\_ref** *Image Ref* Reference images for style/content guidance. Up to 9 for type 'image', up to 8 for type 'image\_edit' (source occupies one slot). Array\ default: <= 9 items *ImageRef* A `MediaRef` with the workspace arm — runs only. A run writes into the session's workspace, so "an asset the workspace already holds" means something there. `/v1/generations` has no session and no workspace to resolve against, which is why this is a subclass and not a sixth arm on `MediaRef`: the base class is what the published SDK renders, and an arm no sessionless caller can use does not belong in it. object **asset\_id** Any of: - [string](#tab-panel-8-0) - [null](#tab-panel-8-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-9-0) - [null](#tab-panel-9-1) string null **file\_id** Any of: - [string](#tab-panel-10-0) - [null](#tab-panel-10-1) string null **generation\_id** Any of: - [string](#tab-panel-11-0) - [null](#tab-panel-11-1) string null **media\_type** Any of: - [string](#tab-panel-12-0) - [null](#tab-panel-12-1) string null **url** Any of: - [string](#tab-panel-13-0) - [null](#tab-panel-13-1) string null **kind** *Kind* string default: generate Allowed value: generate **layering** Any of: - [LayeringControls](#tab-panel-14-0) - [null](#tab-panel-14-1) *LayeringControls* Layering options. Applies only to `type=layering`; rejected on every other type. The image to split goes in `source`, and `prompt` may carry optional guidance for how to split it (up to 500 characters, may be empty). Unknown keys are rejected rather than ignored. object **resolution** *Resolution* Output resolution for every layer. `2k` re-renders each layer at higher quality and costs more; either is one flat price per generation, whatever the number of layers. string default: 1k Allowed values: 1k 2k null **medias** Any of: - [Array\](#tab-panel-15-0) - [null](#tab-panel-15-1) Array\ <= 32 items *RunMedia* One media input to a third-party model: a ref, and the role that picks the model field it lands in. object **asset\_id** Any of: - [string](#tab-panel-16-0) - [null](#tab-panel-16-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-17-0) - [null](#tab-panel-17-1) string null **file\_id** Any of: - [string](#tab-panel-18-0) - [null](#tab-panel-18-1) string null **media\_type** Any of: - [string](#tab-panel-19-0) - [null](#tab-panel-19-1) string null **role** required *MediaRole* What the media is to the model: reference (a reference image), start\_frame, end\_frame, keyframe (an image on the model's keyframe timeline, spaced evenly from the first frame to the last in the order sent), reference\_video or reference\_audio. A role the model does not take is refused, naming the roles it takes. string Allowed values: reference start\_frame end\_frame keyframe reference\_video reference\_audio **url** Any of: - [string](#tab-panel-20-0) - [null](#tab-panel-20-1) string null null **model** *Model* Model to use string default: uni-1 **output\_format** Any of: - [Uni1ImageFormat](#tab-panel-21-0) - [null](#tab-panel-21-1) *Uni1ImageFormat* Uni-1 output image format. string Allowed values: png jpeg null **parameters** Any of: - [object](#tab-panel-22-0) - [null](#tab-panel-22-1) object ***key*** additional properties any null **prompt** required *Prompt* Text prompt string 0 <= 6000 characters **source** Any of: - [ImageRef](#tab-panel-23-0) - [null](#tab-panel-23-1) *ImageRef* A `MediaRef` with the workspace arm — runs only. A run writes into the session's workspace, so "an asset the workspace already holds" means something there. `/v1/generations` has no session and no workspace to resolve against, which is why this is a subclass and not a sixth arm on `MediaRef`: the base class is what the published SDK renders, and an arm no sessionless caller can use does not belong in it. object **asset\_id** Any of: - [string](#tab-panel-24-0) - [null](#tab-panel-24-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-25-0) - [null](#tab-panel-25-1) string null **file\_id** Any of: - [string](#tab-panel-26-0) - [null](#tab-panel-26-1) string null **generation\_id** Any of: - [string](#tab-panel-27-0) - [null](#tab-panel-27-1) string null **media\_type** Any of: - [string](#tab-panel-28-0) - [null](#tab-panel-28-1) string null **url** Any of: - [string](#tab-panel-29-0) - [null](#tab-panel-29-1) string null null **style** *Uni1Style* Style preset (auto, manga) string default: auto Allowed values: auto manga **type** *GenerationType* Generation type string default: image Allowed values: image image\_edit video video\_edit video\_reframe layering **user\_id** Any of: - [string](#tab-panel-30-0) - [null](#tab-panel-30-1) string <= 256 characters null **video** Any of: - [RunVideoControls](#tab-panel-31-0) - [null](#tab-panel-31-1) *RunVideoControls* `VideoControls` whose every frame slot carries the workspace arm. object **duration** Any of: - [string](#tab-panel-32-0) - [null](#tab-panel-32-1) string Allowed values: 5s 10s null **edit** Any of: - [RunVideoEditControls](#tab-panel-33-0) - [null](#tab-panel-33-1) *RunVideoEditControls* `VideoEditControls` whose keyframes carry the workspace arm. object **auto\_controls** Any of: - [boolean](#tab-panel-34-0) - [null](#tab-panel-34-1) boolean null **controls** Any of: - [AdvancedControls](#tab-panel-35-0) - [null](#tab-panel-35-1) *AdvancedControls* Per-signal manual conditioning overrides for a Ray 3.2 video edit. Each signal is a self-describing sub-object — an `enabled` toggle plus (for most signals) a single tuning value. Supplying `controls` puts the edit into manual mode for the signals you specify; omit it entirely to let the model auto-derive the full control schedule from the source video. object **depth** Any of: - [DepthControl](#tab-panel-36-0) - [null](#tab-panel-36-1) *DepthControl* Depth conditioning — adherence to the source's scene geometry. object **blur** Any of: - [number](#tab-panel-37-0) - [null](#tab-panel-37-1) number <= 1 null **enabled** Any of: - [boolean](#tab-panel-38-0) - [null](#tab-panel-38-1) boolean null null **face** Any of: - [FaceControl](#tab-panel-39-0) - [null](#tab-panel-39-1) *FaceControl* Face-identity conditioning (no extra tuning knob beyond `enabled`). object **enabled** Any of: - [boolean](#tab-panel-40-0) - [null](#tab-panel-40-1) boolean null null **normals** Any of: - [NormalsControl](#tab-panel-41-0) - [null](#tab-panel-41-1) *NormalsControl* Surface-normals conditioning. object **augmentation** Any of: - [number](#tab-panel-42-0) - [null](#tab-panel-42-1) number <= 1 null **enabled** Any of: - [boolean](#tab-panel-43-0) - [null](#tab-panel-43-1) boolean null null **pose** Any of: - [PoseControl](#tab-panel-44-0) - [null](#tab-panel-44-1) *PoseControl* Pose conditioning — how tightly the edit tracks the source's motion/pose. object **enabled** Any of: - [boolean](#tab-panel-45-0) - [null](#tab-panel-45-1) boolean null **strength** Any of: - [string](#tab-panel-46-0) - [null](#tab-panel-46-1) string Allowed values: precise coarse null null **trajectory** Any of: - [TrajectoryControl](#tab-panel-47-0) - [null](#tab-panel-47-1) *TrajectoryControl* Motion-trajectory (point-track) conditioning. object **enabled** Any of: - [boolean](#tab-panel-48-0) - [null](#tab-panel-48-1) boolean null **sparsity** Any of: - [number](#tab-panel-49-0) - [null](#tab-panel-49-1) number <= 1 null null null **keyframe\_indexes** Any of: - [Array\](#tab-panel-50-0) - [null](#tab-panel-50-1) Array\ <= 64 items null **keyframes** Any of: - [Array\](#tab-panel-51-0) - [null](#tab-panel-51-1) Array\ <= 64 items *ImageRef* A `MediaRef` with the workspace arm — runs only. A run writes into the session's workspace, so "an asset the workspace already holds" means something there. `/v1/generations` has no session and no workspace to resolve against, which is why this is a subclass and not a sixth arm on `MediaRef`: the base class is what the published SDK renders, and an arm no sessionless caller can use does not belong in it. object **asset\_id** Any of: - [string](#tab-panel-52-0) - [null](#tab-panel-52-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-53-0) - [null](#tab-panel-53-1) string null **file\_id** Any of: - [string](#tab-panel-54-0) - [null](#tab-panel-54-1) string null **generation\_id** Any of: - [string](#tab-panel-55-0) - [null](#tab-panel-55-1) string null **media\_type** Any of: - [string](#tab-panel-56-0) - [null](#tab-panel-56-1) string null **url** Any of: - [string](#tab-panel-57-0) - [null](#tab-panel-57-1) string null null **strength** Any of: - [string](#tab-panel-58-0) - [null](#tab-panel-58-1) string Allowed values: adhere\_1 adhere\_2 adhere\_3 flex\_1 flex\_2 flex\_3 reimagine\_1 reimagine\_2 reimagine\_3 null null **end\_frame** Any of: - [ImageRef](#tab-panel-59-0) - [null](#tab-panel-59-1) *ImageRef* A `MediaRef` with the workspace arm — runs only. A run writes into the session's workspace, so "an asset the workspace already holds" means something there. `/v1/generations` has no session and no workspace to resolve against, which is why this is a subclass and not a sixth arm on `MediaRef`: the base class is what the published SDK renders, and an arm no sessionless caller can use does not belong in it. object **asset\_id** Any of: - [string](#tab-panel-60-0) - [null](#tab-panel-60-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-61-0) - [null](#tab-panel-61-1) string null **file\_id** Any of: - [string](#tab-panel-62-0) - [null](#tab-panel-62-1) string null **generation\_id** Any of: - [string](#tab-panel-63-0) - [null](#tab-panel-63-1) string null **media\_type** Any of: - [string](#tab-panel-64-0) - [null](#tab-panel-64-1) string null **url** Any of: - [string](#tab-panel-65-0) - [null](#tab-panel-65-1) string null null **exr\_export** Any of: - [boolean](#tab-panel-66-0) - [null](#tab-panel-66-1) boolean null **guide\_frame** Any of: - [ImageRef](#tab-panel-67-0) - [null](#tab-panel-67-1) *ImageRef* A `MediaRef` with the workspace arm — runs only. A run writes into the session's workspace, so "an asset the workspace already holds" means something there. `/v1/generations` has no session and no workspace to resolve against, which is why this is a subclass and not a sixth arm on `MediaRef`: the base class is what the published SDK renders, and an arm no sessionless caller can use does not belong in it. object **asset\_id** Any of: - [string](#tab-panel-68-0) - [null](#tab-panel-68-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-69-0) - [null](#tab-panel-69-1) string null **file\_id** Any of: - [string](#tab-panel-70-0) - [null](#tab-panel-70-1) string null **generation\_id** Any of: - [string](#tab-panel-71-0) - [null](#tab-panel-71-1) string null **media\_type** Any of: - [string](#tab-panel-72-0) - [null](#tab-panel-72-1) string null **url** Any of: - [string](#tab-panel-73-0) - [null](#tab-panel-73-1) string null null **hdr** Any of: - [boolean](#tab-panel-74-0) - [null](#tab-panel-74-1) boolean null **keyframe\_indexes** Any of: - [Array\](#tab-panel-75-0) - [null](#tab-panel-75-1) Array\ <= 64 items null **keyframes** Any of: - [Array\](#tab-panel-76-0) - [null](#tab-panel-76-1) Array\ <= 64 items *ImageRef* A `MediaRef` with the workspace arm — runs only. A run writes into the session's workspace, so "an asset the workspace already holds" means something there. `/v1/generations` has no session and no workspace to resolve against, which is why this is a subclass and not a sixth arm on `MediaRef`: the base class is what the published SDK renders, and an arm no sessionless caller can use does not belong in it. object **asset\_id** Any of: - [string](#tab-panel-77-0) - [null](#tab-panel-77-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-78-0) - [null](#tab-panel-78-1) string null **file\_id** Any of: - [string](#tab-panel-79-0) - [null](#tab-panel-79-1) string null **generation\_id** Any of: - [string](#tab-panel-80-0) - [null](#tab-panel-80-1) string null **media\_type** Any of: - [string](#tab-panel-81-0) - [null](#tab-panel-81-1) string null **url** Any of: - [string](#tab-panel-82-0) - [null](#tab-panel-82-1) string null null **loop** Any of: - [boolean](#tab-panel-83-0) - [null](#tab-panel-83-1) boolean null **png\_export** Any of: - [boolean](#tab-panel-84-0) - [null](#tab-panel-84-1) boolean null **resolution** Any of: - [string](#tab-panel-85-0) - [null](#tab-panel-85-1) string Allowed values: 360p 540p 720p 1080p 1440p null **source\_position** Any of: - [SourcePosition](#tab-panel-86-0) - [null](#tab-panel-86-1) *SourcePosition* Normalized source rect inside the output canvas for video\_reframe. All fields are dimensionless ratios relative to the output canvas: `x_norm` and `y_norm` are 0..1 (the source's top-left within the canvas); `w_norm` and `h_norm` are 0..2.0 (the source can extend past the canvas edges, in which case the AI outpaints the visible portion only). object **h\_norm** required *H Norm* Source rect height, fraction of canvas height. Up to 2.0 (source can bleed off-canvas). number \> 0 <= 2 **w\_norm** required *W Norm* Source rect width, fraction of canvas width. Up to 2.0 (source can bleed off-canvas). number \> 0 <= 2 **x\_norm** required *X Norm* Left edge of source rect, fraction of canvas width. Negative when the source extends off-canvas to the left. number \>= -2 <= 2 **y\_norm** required *Y Norm* Top edge of source rect, fraction of canvas height. Negative when the source extends off-canvas to the top. number \>= -2 <= 2 null **start\_frame** Any of: - [ImageRef](#tab-panel-87-0) - [null](#tab-panel-87-1) *ImageRef* A `MediaRef` with the workspace arm — runs only. A run writes into the session's workspace, so "an asset the workspace already holds" means something there. `/v1/generations` has no session and no workspace to resolve against, which is why this is a subclass and not a sixth arm on `MediaRef`: the base class is what the published SDK renders, and an arm no sessionless caller can use does not belong in it. object **asset\_id** Any of: - [string](#tab-panel-88-0) - [null](#tab-panel-88-1) string <= 64 characters null **data** Any of: - [string](#tab-panel-89-0) - [null](#tab-panel-89-1) string null **file\_id** Any of: - [string](#tab-panel-90-0) - [null](#tab-panel-90-1) string null **generation\_id** Any of: - [string](#tab-panel-91-0) - [null](#tab-panel-91-1) string null **media\_type** Any of: - [string](#tab-panel-92-0) - [null](#tab-panel-92-1) string null **url** Any of: - [string](#tab-panel-93-0) - [null](#tab-panel-93-1) string null null null **web\_search** *Web Search* Enable web search grounding — the agent can search the web and download reference images before generating. Similar to Google Imagen's image search feature. boolean One of: - [StartCapabilityRunRequest](#tab-panel-94-0) - [StartCapabilityRunRequest](#tab-panel-94-1) *StartCapabilityRunRequest* Run one of Luma's capabilities under this session, as a child of it. The app runs in a session of its own that the caller never addresses: its gates arrive on this session's feed carrying the `run_id`, its outputs and summary land on this run, and its spend rolls up here. Takes no `attachment_ids` — an attachment is authorized against the session it was uploaded to, and the app's session is not the one the caller holds. A typed `input` may name workspace assets in the app's declared fields; a free-form `content` brief names them by `asset_id`. object **app** required *App* Capability slug, or slug\@version. From GET /v1/apps. string <= 128 characters **content** required string **idempotency\_key** Any of: - [string](#tab-panel-95-0) - [null](#tab-panel-95-1) string <= 255 characters null **input** null **kind** *Kind* string default: capability Allowed value: capability **system\_context** Any of: - [string](#tab-panel-96-0) - [null](#tab-panel-96-1) string <= 32768 characters null *StartCapabilityRunRequest* Run one of Luma's capabilities under this session, as a child of it. The app runs in a session of its own that the caller never addresses: its gates arrive on this session's feed carrying the `run_id`, its outputs and summary land on this run, and its spend rolls up here. Takes no `attachment_ids` — an attachment is authorized against the session it was uploaded to, and the app's session is not the one the caller holds. A typed `input` may name workspace assets in the app's declared fields; a free-form `content` brief names them by `asset_id`. object **app** required *App* Capability slug, or slug\@version. From GET /v1/apps. string <= 128 characters **content** null **idempotency\_key** Any of: - [string](#tab-panel-97-0) - [null](#tab-panel-97-1) string <= 255 characters null **input** required object **kind** *Kind* string default: capability Allowed value: capability **system\_context** Any of: - [string](#tab-panel-98-0) - [null](#tab-panel-98-1) string <= 32768 characters null ## Responses ### 202 Successful Response Media typeapplication/json *RunResponse* One run as a caller reads it — the single handle and the single wait. object **app** Any of: - [string](#tab-panel-99-0) - [null](#tab-panel-99-1) string null **completed\_at** Any of: - [string](#tab-panel-100-0) - [null](#tab-panel-100-1) string format: date-time null **created\_at** required *Created At* string format: date-time **error** Any of: - [object](#tab-panel-101-0) - [null](#tab-panel-101-1) object ***key*** additional properties any null **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\ *RunOutput* One asset a run produced. The durable handle is `asset_id`. object **asset\_id** Any of: - [string](#tab-panel-102-0) - [null](#tab-panel-102-1) string null **layer** Any of: - [OutputLayer](#tab-panel-103-0) - [null](#tab-panel-103-1) *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\ **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 null **mime** Any of: - [string](#tab-panel-104-0) - [null](#tab-panel-104-1) string null **type** Any of: - [string](#tab-panel-105-0) - [null](#tab-panel-105-1) string null **url** Any of: - [string](#tab-panel-106-0) - [null](#tab-panel-106-1) string null ***key*** additional properties any **pending** Any of: - [object](#tab-panel-107-0) - [null](#tab-panel-107-1) object ***key*** additional properties any null **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](#tab-panel-108-0) - [null](#tab-panel-108-1) object ***key*** additional properties null **run\_id** required *Run Id* string **session\_id** required *Session Id* string **settled\_with** Any of: - [string](#tab-panel-109-0) - [null](#tab-panel-109-1) string null **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](#tab-panel-110-0) - [null](#tab-panel-110-1) string null **turn\_id** Any of: - [string](#tab-panel-111-0) - [null](#tab-panel-111-1) string null **updated\_at** required *Updated At* string format: date-time ##### Example ```json { "kind": "brief", "outputs": [ { "layer": { "alpha_hint": "soft", "text": { "font": { "category": "sans serif", "match": { "style": "normal" }, "weight": "thin", "width": "condensed" } } } } ], "replayed": false, "state": "queued" } ``` ### 422 Validation Error Media typeapplication/json *HTTPValidationError* object **detail** *Detail* Array\ *ValidationError* object **ctx** *Context* object **input** *Input* **loc** required *Location* Array **msg** required *Message* string **type** required *Error Type* string ##### Examplegenerated ```json { "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ] } ```