Create an artifact
Response
202 Accepted
status is completed or failed.
Creating an artifact needs write access to the space; read-only members receive
403 space_read_only. You can have one artifact building per space at a time.
Cost
An artifact is billed in credits for the tokens used to build it, plus a flat surcharge per page. Before anything is queued, the request is checked against the most it could cost; if your balance is below that, it is refused with429 credits_exhausted and a message naming the amount. A failed build is not
charged.
List artifacts
{"items": [...]}, newest first, at most 50. You see your own artifacts and
those shared with the space or made public. The space owner sees all of them,
private ones included, so any link built from the space can be found and withdrawn.
Get an artifact
Change sharing
The creator and the space owner can change sharing. Sharing with the space needs
write access to it. Making an artifact public needs the space owner’s authority;
anyone else receives
403 space_owner_only. Returns the updated artifact.
Delete an artifact
204 No Content. Deleting a space deletes its
artifacts too, public ones included: their links stop working at once, and any still
building are cancelled without charge.
Deleting an artifact that is still building cancels the build: it disappears at once,
nothing is charged for it, and it still counts toward the hourly limit.
Open an artifact
200 OK
Anyone else who can open the page, including a signed-out visitor to a public link,
gets
null for these three fields: a link never reveals which space it came from or
how it is shared.
API keys
Every route above accepts an API key as well as a dashboard session. An API key acts as the member it belongs to: it has that member’s access to each space, their role, and their authority, and the artifacts it creates are theirs. A key can do exactly what its member can do in the dashboard, and no more.Errors
A failed build reports one of these in
error_code:
A failed build is not charged.