FARPY Public API V1
Render through the FARPY API
Upload a Blender file, submit the render, track terminal status, download the result and retrieve its receipt and proof.
1. Create an API key
Sign in, open Account Settings, and create an API key. The secret is shown once, so store it securely and never place it in browser code or public logs.
export FARPY_API_KEY="YOUR_FARPY_API_KEY"
Production flow
capabilities pricing upload submit status download receipt proof
API properties
- 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
- Machine-readable OpenAPI 3.1 specification
Python client
Download the dependency-free Python 3 client and run the complete workflow with one high-level method.
from farpy_client import FarpyClient
client = FarpyClient(api_key="YOUR_FARPY_API_KEY")
result = client.render(
"scene.blend",
output_path="render.zip",
)
print(result["job_id"])
print(result["receipt"])
print(result["proof"])Download farpy_client.py · Open the Python example · Verify SHA-256 checksums
Start here
curl -sS https://farpy.com/v1/capabilities \ -H "Authorization: Bearer $FARPY_API_KEY"
API overview · Agent integration guide · Quickstart · OpenAPI · Pricing · Status · Proof