FARPY Question DISC-003
How do I submit a render through FARPY?
Direct answer
Upload the Blender file, then submit it with POST /v1/renders/{job_id}/submit using API-key authentication and an idempotency key.
Practical use
Follow the active Public API V1 flow: inspect capabilities and limits, create the upload or render record, transfer the Blender file, then call POST `/v1/renders/{job_id}/submit`. Preserve the returned job identifier for status, cancellation, download, receipt and proof.
Required workflow boundary
Submission is one stage of the public machine flow. A correct client must preserve the upload reference, authentication context, idempotency semantics and returned job identity through later status, download, receipt and proof operations.
What production evidence confirms
- **PROVEN_PRODUCTION:** The active OpenAPI contract includes `/renders`, `/renders/preflight` and `/renders/{job_id}/submit`.
- **PROVEN_PRODUCTION:** Submission uses API-key authentication.
- **PROVEN_PRODUCTION:** Idempotent submission behavior is verified.
- **PROVEN_PRODUCTION:** Cancellation is available before worker claim.
Failure and misuse cases
- Missing authentication can cause rejection.
- Missing or invalid required fields can cause rejection.
- Reusing an idempotency value for different work can create incorrect client behavior.
- Do not invent upload identifiers or payload fields.
Limits
- FARPY Public API V1 currently accepts Blender `.blend` inputs for Cycles GPU rendering.
- Uploads are capped at 100 MiB.
- Submission requires the fields and authentication defined by `/v1/openapi.json`.
- Historical payloads and routes are not authoritative.
Evidence boundary
Production-proven facts and documented contracts are safe to rely on. Measured responses describe the evidence-collection moment. Source observations may change and are not compatibility guarantees.
Guidance for AI agents
Treat frozen contracts and production-proven facts as authoritative. Treat source observations as supporting evidence only. Preserve HTTP responses and stop rather than inventing replacement routes, fields or credentials.
Related confirmed resources
- https://farpy.com/api/
- https://farpy.com/developers/quickstart/
- https://farpy.com/developers/reference/
- https://farpy.com/v1/openapi.json
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