Get App Surface Template
const url = 'https://agents.lumalabs.ai/v1/apps/example/surface-template';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://agents.lumalabs.ai/v1/apps/example/surface-template \ --header 'Authorization: Bearer <token>'The app's declared intake surface — its pages, fields, and action copy.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Responses
Section titled “ Responses ”Successful Response
A registered app's declared intake surface plus its identity.
The sibling of AppSpecTemplateResponse: that one says what tools and
providers a session gets, this one says what the app asks a user for.
surface_template is the page/field declaration a generated-page renderer
consumes directly; intake_page_id names the page to open on, so no host
re-derives it.
object
The commands member of a declared app's surface template: the
operations and the controls that issue them, verbatim from the package.
Present only while declared_commands_cfg is ON.
object
Which surface element issues which command, and where each param's value comes from. Read server-side only by publish validation; served verbatim to the kit.
object
object
The kit reads the current document value at a <section>.<field> path.
object
The list index of the item tile the affordance sits on (placement: item only).
object
One command a declared app's surface may issue: its name, the tool it
runs, and the JSON Schema of the body the generic /commands route
parses — served so the kit validates before it posts, since a declared slug
is not known when OpenAPI is compiled.
object
object
Which page of surface_template a host opens on.
Whether an image picked from a catalog goes to the run as the library file itself (its media ref) rather than as a copy on the project board.
Frontend renderer id for this app's plan artifact.
Whether runs execute without planner turns.
The plan-artifact schema the app's sessions produce.
The app's declared pages, fields, and action copy.
object
Example
{ "commands": { "affordances": [ { "placement": "document", "sources": { "additionalProperty": { "kind": "from_field" } } } ] }, "picks_as_files": false, "runnable": false}Validation Error
object
object
object
Examplegenerated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}