Blender Render API for Cycles

Canonical machine contract

Public API V1 uses https://farpy.com/v1. Render requests authenticate with Authorization: Bearer and a FARPY API key.

• Capabilities
• Pricing
• Limits
• OpenAPI 3.1.0

What this API is for

Use this route when the workload is specifically a Blender Cycles render and the caller needs a stable machine interface instead of browser automation.

The current public lane is pinned to Blender 4.1.1 on Linux x86_64. Compatibility is evidence-backed for qualified workload classes, but broad arbitrary-Blender compatibility is not claimed.

The API separates discovery, pricing, upload, submission, status, cancellation, delivery, receipt, and proof so each stage can be inspected and retried deliberately.

Blender request lifecycle

Begin with GET /v1/capabilities to read the accepted renderer, supported file expectations, availability, queue state, pricing information, limits, and cancellation rules.

Use POST /v1/renders/preflight before transferring the file. Preflight validates request metadata and calculates the canonical price for the requested frame range.

Upload with POST /v1/renders, then submit the created job with POST /v1/renders/{job_id}/submit. Poll GET /v1/renders/{job_id} or consume a signed terminal webhook.

Before worker claim, POST /v1/renders/{job_id}/cancel can stop execution. After completion, use download, receipt, and proof routes for result retrieval and verification.

Blender-specific request facts

The public price is $0.01 per completed Blender Cycles frame.

A request can cover frames 1 to 10,000. The caller supplies frame_start, frame_end, frame_count, renderer, filename, byte size, and content SHA-256 metadata.

The upload limit is 100 MiB. Oversized requests return HTTP 413 instead of entering the queue.

Render creation supports Idempotency-Key and X-Farpy-Request-Fingerprint so safe retries do not silently create duplicate billable jobs.

Outputs, receipts, and proof

A completed job exposes artifact download information, a signed receipt, and a proof record connected to the canonical job state.

Receipts and proof surfaces exist to show what was requested, what completed, what was charged, and which output belongs to the authenticated workspace.

Global visual correctness for arbitrary Blender projects is not claimed. Published compatibility and determinism statements apply only to the exact fixtures, runtime, configuration, and qualified workload classes named by FARPY evidence.

Implementation paths

Use the API quickstart for the granular request flow, the agent rendering guidefor low-decision automation, and thedeveloper reference for the complete endpoint contract.

Structured error handling is documented in theerror recovery guide. Signed terminal delivery is documented in the webhook guide.

Blender API operating summary

The current public contract is deliberately narrow. FARPY accepts a supported Blender Cycles request, validates its metadata, calculates the price, stores the uploaded blend file, and creates a render job owned by the authenticated workspace. The service does not promise compatibility with every add-on, external asset, renderer setting, or arbitrary Blender project.

Before submitting production work, read /v1/capabilities, /v1/pricing, /v1/limits, and /v1/openapi.json. The published price is $0.01 per completed Blender Cycles frame. Requests support frames 1 to 10,000, a 100 MiB upload ceiling, and 60 requests per minute plus burst capacity.

Successful completion exposes download, receipt, and proof surfaces. Automation may use polling or signed terminal webhooks. Cancellation remains available before worker claim. Structured failures should be handled using their retryable value, suggested action, and request ID.

Frequently asked questions

Does FARPY support Blender Cycles?

Yes. Public API V1 currently exposes a Blender Cycles execution lane pinned to Blender 4.1.1 on Linux x86_64.

How much does a Blender API render cost?

The public price is $0.01 per completed Blender Cycles frame.

What frame range can I submit?

A request can specify frames 1 to 10,000, subject to the current machine-readable limits response.

Can I cancel a Blender render?

Cancellation is supported before worker claim through the job cancellation route.

What can I retrieve after completion?

Completed jobs expose artifact download information, a signed receipt, and a proof record.