Docs / REST API

Build on the REST API

Everything the web app and the Blender add-on do goes through one public API: submit a job, poll it, download the result. Your tools can do the same.

How it works

POST a prompt to /v1/jobs, poll /v1/jobs/{id}, download the finished GLB or FBX from /v1/files. Available models and tasks are discoverable at runtime from /v1/tasks and /v1/models, so your integration picks up new models without code changes.

The same API runs everywhere: against the hosted demo, or against a self-hosted server on your own hardware, your code doesn't care which.

The moving parts

You work here Your code Any language, plain HTTP. No SDK required.

POST /v1/jobs, poll /v1/jobs/{id}→GET /v1/files/{id}.fbx back

Server AnimoFlow API server Async jobs, models discoverable at /v1/tasks. AnimoFlow/animoflow-api API reference at /redoc

→runs

Pipeline Generation pipeline Animation model, cleanup, rigging, export. AnimoFlow/comfyui-animoflow

The highlighted box is the part you touch. The mono links point at each component's source on GitHub.

Open the API reference

Good to know

The full reference at /redoc is generated from the live server, it's never out of date.
Prefer Swagger-style "try it out"? The same spec is at /docs.
Jobs are asynchronous; results are files (GLB for preview, FBX for DCC pipelines).

Build on the REST API

How it works

The moving parts

Good to know

Other ways to use AnimoFlow

Web app

Blender add-on

ComfyUI nodes

Self-host for a team

REST API

Plug in your model

Contributing

Licensing