Deliver Session Artifact
const url = 'https://agents.lumalabs.ai/v1/sessions/example/deliveries';const options = { method: 'POST', headers: { 'X-Studio-Delivery': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'image/jpeg' }, body: 'binary'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://agents.lumalabs.ai/v1/sessions/example/deliveries \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: image/jpeg' \ --header 'X-Studio-Delivery: example' \ --data binaryDeliver a file the app's surface rendered — an export or a capture — into the session's workspace.
The body is the file's bytes, its Content-Type the file's type; the
X-Studio-Delivery header carries the claims the app checks. The
delivery is listed in the session snapshot's deliveries at once, and
once ready reads through GET /v1/sessions/{session_id}/assets/{asset_id}.
A retry of a committed delivery answers the same file.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”URL-encoded JSON: {filename, mimeType, relation: 'capture' | 'export', documentRevision, coordinates, width?, height?}. mimeType must equal the body's Content-Type; documentRevision is the plan artifact revision the file was rendered from; coordinates are the app's own fields naming what was rendered, and the app refuses claims it does not recognise with a 409.
URL-encoded JSON: {filename, mimeType, relation: 'capture' | 'export', documentRevision, coordinates, width?, height?}. mimeType must equal the body's Content-Type; documentRevision is the plan artifact revision the file was rendered from; coordinates are the app's own fields naming what was rendered, and the app refuses claims it does not recognise with a 409.
Request Bodyrequired
Section titled “Request Bodyrequired”Responses
Section titled “ Responses ”Successful Response
The file a delivery stored, named as the session snapshot's deliveries name it.
object
Once its delivery is ready, read it through GET /v1/sessions/{session_id}/assets/{asset_id}.
Examplegenerated
{ "artifact_id": "example"}Validation Error
object
object
object
Examplegenerated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}