Render a prepared PDF artifact
Render a prepared artifact.
modeis required:syncwaits for the result andasyncqueues it.- The artifact is returned in state
ready(200) or still pending (202); poll the show operation while it isqueuedorprocessing. - Rendering an artifact that is already ready changes nothing.
- It counts against the PDF generation budget.
- Requires
pdfs:readandIdempotency-Key.
Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.
In: header
Path Parameters
Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).
uuidPublic identifier (UUID v7) of the PDF artifact.
uuidHeaders
Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.
1 <= length <= 255Pin 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.
dateRequest Body
application/json
Internal reversible preparation/rendering uses the existing idempotency policy; the same key and raw body replay, another body with that key is rejected with 422 idempotency_key_reused before admission.
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json