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.

Discover live service facts

Agents should read the public machine endpoints at runtime instead of hard-coding price, capacity, or request limits.

Model Context Protocol (MCP)

The FARPY MCP server lets autonomous agents discover and invoke FARPY's 10 MCP tools over a standard stdio connection. Set the FARPY_API_KEY environment variable in the agent's MCP server configuration; the key is read from the environment and is not part of a tool call.

Before rendering, agents can inspect the live capabilities, pricing, and limits contracts. FARPY MCP is currently available as a LIVE_PUBLIC_ALPHA interface, so agents should rely on those live contracts rather than hard-coded assumptions.

Agent-ready path

  1. Sign in and create an API key in Account Settings.
  2. Read capabilities, pricing and limits at runtime instead of hard-coding assumptions.
  3. Use the dependency-free Python client or the OpenAPI 3.1 contract.
  4. Submit with an idempotency key and an optional signed terminal webhook.
  5. Poll status or consume render.completed, render.failed and render.cancelled events.
  6. Download the output, receipt and proof after terminal completion.

One-call Python workflow

import os
from farpy_client import FarpyClient, FarpyError

client = FarpyClient(os.environ["FARPY_API_KEY"])

try:
    result = client.render(
        "scene.blend",
        output_path="render.zip",
    )
    print(result["job_id"])
    print(result["receipt"])
    print(result["proof"])
except FarpyError as exc:
    print(exc.code)
    print(exc.retryable)
    print(exc.suggested_action)
    print(exc.request_id)
    raise

Download farpy_client.py · Open the Python example · Error contract · Webhook contract

Production flow

capabilities
pricing
upload
submit
status
cancel before worker claim
download
receipt
proof

API properties

Start here

curl -sS https://farpy.com/v1/capabilities \
  -H "Authorization: Bearer $FARPY_API_KEY"

API overview · Quickstart · OpenAPI · Pricing · Status · Proof