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 Handles HTTP HEAD requests for a specific blob, checking its existence and NSFW level.

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).

POST Copy a trusted url into a blob named after that source, so the caller can ask for it again without holding the bytes. 200 when it already existed, 201 when copied.

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.

CivitaiConsumer

DELETE DELETE /v2/consumer/civitai/{userId}

DELETE DELETE /v2/consumer/civitai/{userId}/tokens

Recipes

POST Workflow step for generating music using ACE Step 1.5. /// Produces full songs from text descriptions and structured lyrics.

POST Age classification

POST Audio Captioning

POST POST /v2/consumer/recipes/batchOCRSafetyClassification

POST Bundles a set of blobs into a single archive (zip or tar) that callers can /// 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 Echo

POST POST /v2/consumer/recipes/humanoidImageMask

POST A workflow step that removes the background from an image using BiRefNet (builds a ComfyUI graph under the hood and runs it as a comfy job).

POST Image Generation

POST LORA Training

POST Image scanning

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 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 ModelClamScan

POST ModelHash

POST ModelParseMetadata

POST ModelPickleScan

POST 3D model generation

POST Prepare Resource

POST POST /v2/consumer/recipes/preprocessImage

POST POST /v2/consumer/recipes/preprocessVideo

POST PromptEnhancement

POST Qwen Image Bench

POST Repeat workflow step.

POST ShieldstralModeration

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

POST WDTagging

POST WebScrape

POST WebSearch

POST XGuardModeration

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}

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}

Delete all workflow tags

DELETE

/v2/consumer/workflows/{workflowId}/tags

Parameters

Path Parameters

workflowId*

The ID of the worfklow to update.

Type

string

Required

Responses

No Content

DELETE

/v2/consumer/workflows/{workflowId}/tags

Playground

Variables

Key

Value

workflowId*

Samples

Powered by VitePress OpenAPI

Pager

Previous page POST Add workflow tag

Next page DELETE Delete workflow tag

Civitai Developer Documentation

© 2026 Civitai