FARPY Public API V1
Rendering infrastructure for agents
Agents can discover capabilities, obtain pricing, submit work, track status and retrieve results through one public API without browser automation.
Agent-ready path
- Sign in and create an API key in Account Settings.
- Read capabilities, pricing and limits at runtime instead of hard-coding assumptions.
- Use the dependency-free Python client or the OpenAPI 3.1 contract.
- Submit with an idempotency key and an optional signed terminal webhook.
- Poll status or consume render.completed, render.failed and render.cancelled events.
- Download the output, receipt and proof after terminal completion.
One-call Python workflow
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 · Error contract · Webhook contract
Production flow
capabilities pricing upload submit status cancel before worker claim 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
Start here
curl -sS https://farpy.com/v1/capabilities \ -H "Authorization: Bearer $FARPY_API_KEY"
API overview · Quickstart · OpenAPI · Pricing · Status · Proof