Skip to content

Civitai Developer

Main Navigation Orchestration Civitai Site Apps

Orchestration Guide

Orchestration Recipes

Orchestration Reference

Orchestration MCP

Civitai Site Guide

Civitai Site OAuth

Civitai Site Reference

Apps Component Showcase

Apps Design Tokens

Appearance

Sidebar Navigation

Reference

Overview

Blobs

GET Get blob by ID. This will redirect to a cacheable content URL.

HEAD Same as GET, but answers 204 with the redirect target in Location, so a client can read the verdict headers before loading the content.

GET Get a presigned URL for browser uploads. The returned URL points to POST /v2/consumer/blobs with a signature for authentication.

POST Upload a blob directly with on-the-fly moderation. Supports both authenticated requests (Bearer token) and presigned URLs (sig query param).

GET Serves cacheable blob content using a deterministic encrypted token

GET Serves a blocked placeholder image with the specified dimensions

GET Streams an archive (zip or tar) of the blobs referenced by a signed archive token. Tokens are produced by the `blobArchive` workflow step.

POST Refresh a blob's URL and debounce its lifetime. Returns a fresh presigned URL and resets the 30-day TTL.

Free tier

GET Get the free-tier models and the caller's remaining quota. Use them with `tier: "free"` on a workflow, `?tier=free` on a recipe, or `X-Civitai-Tier: free` on the OpenAI-compatible chat endpoint.

Funds

POST The id is the only way to reach the fund, so keep it secret, in your app's state.

GET GET /v2/consumer/funds/{fundId}

DELETE What is left goes back to the depositor when only one user deposited, else to Civitai. A fund is also deleted on its own at `expiresAt`.

PATCH Sets the fund to expire `ttl` from now, so a long-running session can keep rolling it over.

POST POST /v2/consumer/funds/{fundId}/deposits

POST Pays what is left back to the depositor now, when only one user deposited. The fund stays open, empty, for new deposits.

Recipes

POST Generates full songs from text descriptions and structured lyrics with ACE Step 1.5.

POST Archive Extraction

POST Audio Captioning

POST POST /v2/consumer/recipes/audioClassification

POST Transcribe every audio track and classify the lyrics for sexualized minors.

POST Classify transcribed lyrics for sexualized minors.

POST Bundles blobs into a single zip or tar that callers download from a signed streaming URL. /// Runs in-process in the orchestrator; no worker job is dispatched.

POST ChatCompletion

POST Comfy workflows

POST POST /v2/consumer/recipes/comfyNodepackSnapshot

POST Compose Media

POST A workflow step that converts images to different formats and applies optional transforms.

POST CustomComfy

POST POST /v2/consumer/recipes/humanoidImageMask

POST Removes the background from an image using BiRefNet.

POST Image Generation

POST LORA Training

POST Converts a raster image to an SVG using a local StarVector or OmniSVG model.

POST Image upload

POST POST /v2/consumer/recipes/imageUpscaler

POST Live text to speech

POST Live transcription

POST Media Captioning

POST MediaHash

POST MediaRating

POST Merge

POST Generate a complete song from a structured caption and lyrics with MiniMax Music 3.

POST 3D model preview

POST Check a checkpoint for evidence of specified merged LoRAs.

POST ModelHash

POST ModelParseMetadata

POST Multimodal Embedding

POST 3D model generation

POST Prepare Resource

POST POST /v2/consumer/recipes/preprocessImage

POST POST /v2/consumer/recipes/preprocessVideo

POST PromptEnhancement

POST PromptModeration

POST Qwen Image Bench

POST Repeat workflow step.

POST Generate music or a standalone sound effect from a text prompt with Sonilo.

POST TextToImage

POST Text-to-Speech

POST Training

POST Transcoding

POST Transcription

POST POST /v2/consumer/recipes/tryOnU

POST Tracks a prompted foreground object across a video and returns a lossless animated WebP with transparency.

POST Upscale videos and/or interpolate frames

POST Video Frame Extraction

POST Video generation

POST Interpolate videos using VFI Mamba

POST Extract metadata from videos including width, height, FPS, and duration

POST Upscale videos using FlashVSR or RelayVSR.

POST WDTagging

POST WebScrape

POST WebSearch

POST Generate a song from style and lyrics with YuE2.

Resources

GET List resources: `view=Queue` is what the orchestrator is loading now, `view=Loaded` what at least one worker holds and can use now. Each page is a fresh snapshot.

GET Get an existing resource.

Services

GET List services, optionally filtered.

GET Get a single service by id, e.g. "image/flux2/klein/createImage/9b", with its bucketed history over the window.

StreamingBlobs

GET GET /v2/consumer/streaming-blobs/{blobKey}

POST POST /v2/consumer/streaming-blobs/{blobKey}

Workflows

GET Query workflows

POST Submit workflow

GET Get workflow

PUT Update workflow

DELETE Delete workflow

PATCH Patch workflow

POST Add workflow tag

DELETE Delete all workflow tags

DELETE Delete workflow tag

WorkflowSteps

GET Get the status of a workflow step

PUT Updates a step within a particular workflow.

PATCH PATCH /v2/consumer/workflows/{workflowId}/steps/{stepName}

Multimodal Embedding

POST

/v2/consumer/recipes/multimodalEmbedding

Embeds a batch of images or text into the same vector space.

Parameters

Query Parameters

experimental

Type

boolean

allowMatureContent

Type

boolean

whatif

Type

boolean

ephemeral

Type

boolean

tier

How a workflow is paid for.

Type

string

Valid values

"paid""free"

tags

Type

array

Request Body

JSON

Responses

OK

Content-Type

application/json

JSON

POST

/v2/consumer/recipes/multimodalEmbedding

Playground

Variables

Key

Value

experimental

allowMatureContent

whatif

ephemeral

tier

tags

Body

Samples

Powered by VitePress OpenAPI

Pager

Previous page POST ModelParseMetadata

Next page POST 3D model generation

Civitai Developer Documentation

© 2026 Civitai