RResumezBeta
API reference/Career graph/Exports
POSTLive

Export artifact to a stored file

Renders an artifact into a stored file (pdf, json, or txt) in the private exports bucket.

/v1/artifacts/{artifactId}:export

Authorization

Credential

oauth_user

Required scopes

artifacts:readartifacts:export

Path parameters

artifactId

string · required

Request body

JSON · application/json

formatstringrequired

pdf · json · txt

Implementation note

Returns an Operation whose `resultData` carries the export id; mint the signed download URL with `resume-export-download`. PDF renders through the workspace render pipeline from the artifact's profile snapshot (artifacts without a snapshot — e.g. hand-created — can export json/txt only). A render failure ends the Operation `failed` with `error` set.

Error responses

400Invalid request

The request body was missing, malformed, or failed schema validation. Field-level problems are listed under `issues`.

401Authentication required

No valid credentials were supplied. Attach a Bearer access token and retry.

402Upgrade required

The authenticated user's plan does not include this capability. `feature` names the gated capability, `requiredPlan` the cheapest plan that unlocks it, `currentPlan` the user's plan today, and `upgradeUrl` links to checkout. This is a plan gate, not a transient error — retrying without upgrading fails again; surface `upgradeUrl` to the user instead. Dormant until a plan that grants the feature is active, so a route that documents it may not currently return it.

403Insufficient scope

The token is valid but lacks the OAuth scope (or token kind) this endpoint requires.

404Resource not found

The addressed resource does not exist, or is not visible to the caller.