Farpy Renders API
The Renders API from Farpy — 8 operation(s) for renders.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/farpy-com:farpy-com-renders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: FARPY Public Renders API
version: 1.0.0
description: Blender Cycles rendering at one USD cent per frame.
servers:
- url: https://api.farpy.com/v1
tags:
- name: Renders
paths:
/renders/preflight:
post:
operationId: preflightRender
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PreflightRequest'
responses:
'200':
description: Eligible render request
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Preflight render
x-summary-source: derived
/renders:
post:
operationId: createRender
description: Upload idempotency headers are optional as a group. If any one of the nine headers is supplied, all nine must be supplied together.
security:
- bearerAuth: []
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: string
minLength: 1
description: Optional only when all upload idempotency headers are absent. If supplied, all nine headers in this operation are required together. Reuse only for the same logical upload.
- name: X-Farpy-Request-Fingerprint
in: header
required: false
schema:
type: string
pattern: ^[a-f0-9]{64}$
description: Lowercase SHA-256 of the exact UTF-8 string filename=VALUE\nrenderer=VALUE\nframe_start=VALUE\nframe_end=VALUE\nframe_count=VALUE\nsize_bytes=VALUE\nsha256=VALUE, joined with literal newline characters and no trailing newline. Required with the complete nine-header group.
- name: X-Farpy-Filename
in: header
required: false
schema:
type: string
minLength: 1
description: Canonical upload filename used in the request fingerprint. Required with the complete nine-header group.
- name: X-Farpy-Renderer
in: header
required: false
schema:
type: string
description: Canonical renderer value used in the request fingerprint. Required with the complete nine-header group.
- name: X-Farpy-Frame-Start
in: header
required: false
schema:
type: string
pattern: ^[1-9]\d*$
description: Positive integer frame start serialized as a request-header string. Required with the complete nine-header group.
- name: X-Farpy-Frame-End
in: header
required: false
schema:
type: string
pattern: ^[1-9]\d*$
description: Positive integer frame end serialized as a request-header string. Required with the complete nine-header group.
- name: X-Farpy-Frame-Count
in: header
required: false
schema:
type: string
pattern: ^[1-9]\d*$
description: Positive integer frame count serialized as a request-header string. Required with the complete nine-header group.
- name: X-Farpy-Size-Bytes
in: header
required: false
schema:
type: string
pattern: ^(0|[1-9]\d*)$
description: Non-negative integer content size serialized as a request-header string. Required with the complete nine-header group.
- name: X-Farpy-Content-SHA256
in: header
required: false
schema:
type: string
pattern: ^[a-f0-9]{64}$
description: Lowercase 64-hex SHA-256 of the uploaded file bytes. Required with the complete nine-header group.
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/RenderUploadRequest'
responses:
'200':
description: Render job created
content:
application/json:
schema:
$ref: '#/components/schemas/RenderObject'
'401':
description: Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'415':
description: Multipart form data required
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Create render
x-summary-source: derived
/renders/{job_id}/submit:
post:
operationId: submitRender
security:
- bearerAuth: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Render submitted
content:
application/json:
schema:
$ref: '#/components/schemas/RenderObject'
'401':
description: Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Submit render
x-summary-source: derived
/renders/{job_id}/cancel:
post:
operationId: cancelRender
security:
- bearerAuth: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Render cancelled
'404':
description: Render not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Render cannot be cancelled
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Cancel render
x-summary-source: derived
/renders/{job_id}:
get:
operationId: getRender
security:
- bearerAuth: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Render status
content:
application/json:
schema:
$ref: '#/components/schemas/RenderObject'
'401':
description: Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Get render
x-summary-source: derived
/renders/{job_id}/download:
get:
operationId: getRenderDownload
security:
- bearerAuth: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Download URL
content:
application/json:
schema:
$ref: '#/components/schemas/RenderObject'
'401':
description: Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Get render download
x-summary-source: derived
/renders/{job_id}/receipt:
get:
operationId: getRenderReceipt
security:
- bearerAuth: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Receipt URL
content:
application/json:
schema:
$ref: '#/components/schemas/RenderObject'
'401':
description: Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Get render receipt
x-summary-source: derived
/renders/{job_id}/proof:
get:
operationId: getRenderProof
security:
- bearerAuth: []
parameters:
- name: job_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Receipt-backed proof
content:
application/json:
schema:
$ref: '#/components/schemas/RenderProof'
'401':
description: Invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Renders
summary: Get render proof
x-summary-source: derived
components:
schemas:
Error:
type: object
required:
- ok
- error
properties:
ok:
type: boolean
const: false
error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
retryable:
type: boolean
suggested_action:
type: string
request_id:
type: string
retry_after_seconds:
type: number
minimum: 0
detail: {}
RenderUploadRequest:
type: object
required:
- file
properties:
file:
type: string
format: binary
webhook_url:
type: string
format: uri
maxLength: 2048
description: HTTPS endpoint for render.completed, render.failed, and render.cancelled events.
webhook_secret:
type: string
minLength: 16
writeOnly: true
description: Optional signing secret. FARPY generates one when omitted.
RenderObject:
type: object
additionalProperties: true
properties:
webhook_configured:
type: boolean
description: True when terminal render webhooks are configured.
PreflightRequest:
type: object
required:
- filename
properties:
filename:
type: string
pattern: \.blend$
renderer:
type: string
const: blender
default: blender
frame_start:
type: integer
minimum: 1
default: 1
frame_end:
type: integer
minimum: 1
frame_count:
type: integer
minimum: 1
maximum: 10000
RenderProof:
type: object
required:
- ok
- job_id
- proof
- receipt_url
properties:
ok:
type: boolean
const: true
job_id:
type: string
proof:
type: string
const: receipt_backed
receipt_url:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: FARPY API key
sessionCookie:
type: apiKey
in: cookie
name: farpy_session