post/api/v1/docs-sites/{spaceId}/previews

Request

  • Base URL: https://falconer.com (the document declares no server; this is the origin it was published from)
  • URL: https://falconer.com/api/v1/docs-sites/{spaceId}/previews
  • Auth: none declared

Path parameters

spaceIdinteger required

Space id, from GET /spaces.

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

documentIdstring

Open the preview on this document's page.

Response

Preview build queued.

buildIdstring required
documentIdstring nullable required

The page previewUrl opens on. Not stored with the build, so pass it again when polling.

status'queued' | 'building' | 'succeeded' | 'failed' required
errorstring nullable required
previewUrlstring nullable required

Set once the build succeeded. Opens in a browser signed in to Falconer.

blockedByAnotherBuildboolean required
queuedForMsinteger nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.