FARPY Question DISC-001
What is the FARPY API?
Direct answer
The FARPY API is the public machine interface for submitting, tracking, cancelling and retrieving GPU render work. Its confirmed flow covers health, capabilities, pricing, limits, upload, submit, status, cancellation before worker claim, download, receipt, proof and workspace render listing.
Practical use
Use the API when software, scripts or AI agents need to run FARPY without browser automation. Start with health and capabilities, inspect pricing and limits, upload the source file, submit the job, read status, then retrieve the artifact, receipt and proof.
What production evidence confirms
- **PROVEN_PRODUCTION:** FARPY Public API V1 is LIVE_PUBLIC_ALPHA and GREEN.
- **PROVEN_PRODUCTION:** The confirmed machine flow covers health, capabilities, pricing, limits, upload, submit, status, cancel, download, receipt, proof and workspace listing.
- **PROVEN_PRODUCTION:** FARPY publishes OpenAPI 3.1 at `/v1/openapi.json`.
- **PROVEN_PRODUCTION:** Uploads are capped at 100 MiB.
Failure and misuse cases
- Do not infer undocumented operations, limits or guarantees.
- Do not treat request rejection as proof that render execution failed.
- Do not expose API credentials in browser code, logs or public examples.
- Do not automate retries without checking whether the error is retryable.
Limits
- This page reflects FARPY Public API V1.
- Historical routes and old configuration files are not authoritative.
- The machine-readable contract is published at /v1/openapi.json.
- Exact authenticated request bodies belong in operation-specific reference pages.
Evidence boundary
This page separates frozen production facts from implementation guidance. Claims
are limited to the cited Public API V1 evidence. Missing details are not guessed.
Guidance for AI agents
Read health, capabilities, pricing and limits before performing work. Preserve
request identifiers, use idempotency where supported, obey retry timing and stop
when the contract or evidence does not support the requested action.
Related confirmed resources
- `/api/`
- `/developers/reference/`
- `/v1/openapi.json`
- `/questions/`
Source status
Published in production. Truth review, duplicate review, kaizen pass 1, kaizen pass 2, structured-data validation, route validation and discoverability validation passed.
Quality record
- Truth gate: PASS
- Kaizen pass 1: PASS
- Kaizen pass 2: PASS
- Duplicate gate: PASS