Skip to content

Generate App Page

POST
/app-pages/{page_id}/generate

Generate the page from its sources. Asynchronous; poll /status.

Billed, and rate-capped per organization per day. The ordering behind this (re-authorize every source before spend, consume the cap, mark generating, enqueue, refund and mark failed on error) is shared with the internal surface rather than reimplemented here.

404 covers both an unknown page and a source that has become unreachable since the page was created. Distinguishing them would let a caller probe which sources exist.

Authorizations

Parameters

Path Parameters

page_id
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
instruction
Any of:
string
<= 2000 characters

Responses

200

Successful Response

object
data
required
object
job_id
Any of:
string
page_id
required
string
status
string
default: generating
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string