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
- **DOCUMENTED_CONTRACT:** The confirmed public API contract identifies /api/health and /api/submit. Evidence: `api-contract.body`
- **MEASURED:** GET /api/health returned HTTP 200 during the evidence collection run. Evidence: `api-health.headers`
- **MEASURED:** The live health response reported ok=true. Evidence: `api-health.body`
- **MEASURED:** The live health response identified the service as farpy-jobs-api. Evidence: `api-health.body`
- **DOCUMENTED_CONTRACT:** POST /api/submit is listed in the confirmed public API contract as the render submission route. Evidence: `api-contract.body`
- **DOCUMENTED_CONTRACT:** The confirmed API contract classifies /api/submit access as authenticated. Evidence: `api-contract.body`
- **MEASURED:** Submitting an empty JSON object to /api/submit returned HTTP 400. Evidence: `submit-empty-json.headers`
- **MEASURED:** The empty submit probe returned a machine-readable JSON response. Evidence: `submit-empty-json.body`
- **MEASURED:** An unauthenticated audit-only submission probe returned HTTP 400. Evidence: `submit-no-auth-placeholder.headers`
- **PROVEN_PRODUCTION:** FARPY Public API V1 is frozen as LIVE_PUBLIC_ALPHA with production status GREEN. Evidence: `public API canonical sendoff evidence`
- **PROVEN_PRODUCTION:** The public API accepts uploads up to 100 MiB. Evidence: `upload-limit.txt`
- **PROVEN_PRODUCTION:** The frozen FARPY Public API V1 exposes the confirmed machine flow: health, capabilities, pricing, limits, upload, submit, status, cancel, download, receipt, proof, workspace. Evidence: `api-overview-exact.txt`
- **MEASURED:** FARPY publishes a machine-readable API contract at /api-contract.json. Evidence: `api-contract.json.body`
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 packet reflects the production evidence collected for batch-001.
- Historical routes and old configuration files are not authoritative.
- No unsupported endpoint may be introduced during drafting.
- This overview covers the confirmed API surface. Exact authenticated request bodies belong in operation-specific reference pages.
- No public OpenAPI document was confirmed. FARPY currently publishes /api-contract.json as its machine-readable contract.
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/`
- `/api-contract.json`
- `/questions/`
Source status
- Packet status before drafting: `ELIGIBLE_FOR_DRAFT`
- Truth review: pass
- Duplicate review: pass
- Kaizen pass 1: pass
- Kaizen pass 2: pass
- Publication: blocked pending structured data and route gates
Quality record
- Truth gate: PASS
- Kaizen pass 1: PASS
- Kaizen pass 2: PASS
- Duplicate gate: PASS