gsc

A client PDF's state and download link

One client PDF: its period, sections, state and the state's sentence (what a waiting PDF waits for and when Frontshelf tries again, why a failed one failed, when and why a withdrawn one was withdrawn), and on a ready PDF download_url, a signed link good for 15 minutes with no Authorization header: hand it to your human, never anywhere else. A withdrawn (invalidated) PDF has no link: the data it held was erased. A PDF that is not this workspace's, or is on a site this key cannot see, is NOT_FOUND.

get/v1/search/pdfs/{pdf_id}

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/search/pdfs/{pdf_id}
  • Auth: HTTP bearer

Path parameters

pdf_idstring required

The PDF's id (spdf_…), from gsc_pdfs_request.

Response

A client PDF's state and download link

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

idstring required

The PDF's id (spdf_…): what gsc_pdfs_get takes.

site_idstring required

The site's canonical id.

sectionsstring[] required
state'queued' | 'building' | 'waiting' | 'ready' | 'failed' | 'invalidated' required

queued or building (the renderer makes it), waiting (a prerequisite that can return), ready, failed, or invalidated (withdrawn: data it held was erased).

reason'no_blob_store' | 'not_final' | 'not_connected' | 'gated' | 'render_failed' | 'store_failed' | 'expired' | 'source_erased' | 'analytics_erased'

Why it waits, failed or was withdrawn.

next_try_atstring

A waiting PDF: when Frontshelf tries again.

ready_atstring

An instant, ISO 8601.

bytesinteger

A ready PDF's size.

atstring

A withdrawn PDF: when it was withdrawn.

sentencestring nullable required

The state in words: what a waiting PDF waits for and when it tries again, why one failed, when and why one was withdrawn; null for queued, building and ready.

download_urlstring nullable required

A ready PDF's signed download link, good for 15 minutes with no Authorization header; null in every other state. A secret: hand it to your human, never anywhere else.

Changes

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