FARPY Public API V1

Predictable errors and retries

Use HTTP status, stable error codes, retry timing and idempotency keys to operate reliable FARPY integrations.

Production flow

capabilities
pricing
upload
submit
status
download
receipt
proof

API-key authentication
100 MiB upload limit
Idempotent submission support
60 requests per minute plus burst capacity
Cancellation before worker claim
Signed terminal webhooks
Receipts and proof artifacts
Error responses include error.code and error.message
retryable is not currently emitted as a response field; use HTTP status and retry timing to decide whether to retry
suggested_action is not currently emitted as a response field; integrations should map stable error codes to their own actions
Rate-limit responses include retry_after_seconds and Retry-After
Request identifiers are not currently guaranteed
Machine-readable OpenAPI 3.1 specification

Retry HTTP 429 only after Retry-After or retry_after_seconds.
Retry temporary network, HTTP 502 and HTTP 504 failures with bounded exponential backoff.
Reuse the same idempotency key after an uncertain submission result.
Stop on authentication, validation, balance and terminal job failures until the cause is corrected.
Preserve the job ID, HTTP status, error.code and error.message for diagnostics.

curl -sS https://farpy.com/v1/capabilities \
  -H "Authorization: Bearer $FARPY_API_KEY"