Upload idempotency headers are optional as a group. If any one of the nine headers is supplied, all nine must be supplied together.

post/renders

Request

  • Base URL: https://api.farpy.com/v1
  • URL: https://api.farpy.com/v1/renders
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional only when all upload idempotency headers are absent. If supplied, all nine headers in this operation are required together. Reuse only for the same logical upload.

X-Farpy-Request-Fingerprintstring

Lowercase SHA-256 of the exact UTF-8 string filename=VALUE\nrenderer=VALUE\nframe_start=VALUE\nframe_end=VALUE\nframe_count=VALUE\nsize_bytes=VALUE\nsha256=VALUE, joined with literal newline characters and no trailing newline. Required with the complete nine-header group.

X-Farpy-Filenamestring

Canonical upload filename used in the request fingerprint. Required with the complete nine-header group.

X-Farpy-Rendererstring

Canonical renderer value used in the request fingerprint. Required with the complete nine-header group.

X-Farpy-Frame-Startstring

Positive integer frame start serialized as a request-header string. Required with the complete nine-header group.

X-Farpy-Frame-Endstring

Positive integer frame end serialized as a request-header string. Required with the complete nine-header group.

X-Farpy-Frame-Countstring

Positive integer frame count serialized as a request-header string. Required with the complete nine-header group.

X-Farpy-Size-Bytesstring

Non-negative integer content size serialized as a request-header string. Required with the complete nine-header group.

X-Farpy-Content-SHA256string

Lowercase 64-hex SHA-256 of the uploaded file bytes. Required with the complete nine-header group.

Response

Render job created

webhook_configuredboolean

True when terminal render webhooks are configured.

Changes

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