Factuarea APIDevelopers
Support
Open app

Read PDF artifact metadata

Read the state of an artifact (prepared, queued, processing, ready, failed, unavailable or corrupt), its hash, size and download_url once it is ready.

  • It never prepares or renders anything.
  • Requires pdfs:read.
GET
/companies/{company}/pdf-artifacts/{artifact}

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid
artifact*string

Public identifier (UUID v7) of the PDF artifact.

Formatuuid

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Previous/v1/companies/{company}/pdf-artifacts
POST

Prepare an exact presentation PDF

Reserve the artifact of one retained presentation of a document without rendering it. Send document_type, document_id, presentation_id, purpose, format and variant (official or alternative); every field is required and unknown fields are rejected. Repeating the same selection returns the same artifact. Render it afterwards with the render operation. Requires pdfs:read and Idempotency-Key.

Next/v1/companies/{company}/pdf-artifacts/{artifact}/download
GET

Download the exact retained PDF

Download the retained bytes of a ready artifact as application/pdf (Content-Disposition: attachment). The ETag is the SHA-256 of the file; send it in If-None-Match to receive 304 Not Modified. Authorization and integrity are verified before any 304. Requires pdfs:read.