Civitai

aid: civitai
url: https://raw.githubusercontent.com/api-evangelist/civitai/refs/heads/main/apis.yml
apis:
  - aid: civitai:civitai-site-api
    name: Civitai Site API
    tags:
      - AI
      - Artificial Intelligence
      - Image Generation
      - Models
      - Stable Diffusion
      - Flux
      - LoRA
      - Community
    humanURL: https://developer.civitai.com/site/reference/
    properties:
      - url: https://developer.civitai.com/site/
        type: Documentation
      - url: https://developer.civitai.com/site/reference/
        type: Documentation
      - url: https://developer.civitai.com/site/reference/models
        type: Documentation
      - url: https://developer.civitai.com/site/reference/images
        type: Documentation
      - url: https://developer.civitai.com/site/reference/creators
        type: Documentation
      - url: https://developer.civitai.com/site/reference/users
        type: Documentation
      - url: https://developer.civitai.com/site/reference/permissions
        type: Documentation
      - url: https://developer.civitai.com/site/reference/vault
        type: Documentation
      - url: openapi/civitai-site-api-openapi.yml
        type: OpenAPI
      - url: json-schema/civitai-model-schema.json
        type: JSONSchema
      - url: json-schema/civitai-image-schema.json
        type: JSONSchema
      - url: json-ld/civitai-context.jsonld
        type: JSONLD
    description: >-
      Browse and search the Civitai public catalog of Stable Diffusion, SDXL, Flux, and video models. The Site API
      exposes models, model versions, images, creators, tags, users, permissions, and the user vault over
      `https://civitai.com/api/v1/`. Supports hash-based version lookup, AIR identifiers, and Bearer-token
      authentication via personal API keys. Public endpoints are cached; authenticated endpoints are not.
  - aid: civitai:civitai-orchestration-api
    name: Civitai Orchestration API
    tags:
      - AI
      - Artificial Intelligence
      - Image Generation
      - Video Generation
      - Audio Generation
      - LoRA Training
      - Webhooks
      - Workflows
    humanURL: https://developer.civitai.com/orchestration/reference/
    properties:
      - url: https://developer.civitai.com/orchestration/
        type: Documentation
      - url: https://developer.civitai.com/orchestration/guide/
        type: Documentation
      - url: https://developer.civitai.com/orchestration/guide/getting-started
        type: Documentation
      - url: https://developer.civitai.com/orchestration/guide/authentication
        type: Authentication
      - url: https://developer.civitai.com/orchestration/guide/workflows
        type: Documentation
      - url: https://developer.civitai.com/orchestration/guide/submitting-work
        type: Documentation
      - url: https://developer.civitai.com/orchestration/guide/results-and-webhooks
        type: Webhooks
      - url: https://developer.civitai.com/orchestration/guide/errors-and-retries
        type: Errors
      - url: https://developer.civitai.com/orchestration/reference/
        type: Documentation
      - url: https://developer.civitai.com/orchestration/recipes/
        type: Documentation
      - url: openapi/civitai-orchestration-api-openapi.yml
        type: OpenAPI
      - url: json-schema/civitai-workflow-schema.json
        type: JSONSchema
      - url: examples/civitai-image-generation-example.json
        type: Example
      - url: examples/civitai-video-generation-example.json
        type: Example
    description: >-
      Submit AI generation workflows — image, video, audio, language, and LoRA training — through a single contract at
      `https://orchestration.civitai.com`. Races multiple providers and engines (Flux 1/2, SDXL, SD1, Z-Image, Qwen,
      Seedream, Grok, WAN 2.1-2.7, Kling, LTX2, Vidu, Veo 3, HunyuanVideo) behind one workflow API. Includes blob upload
      with NSFW moderation, presigned URLs, in-order serialized webhooks (`workflow:succeeded`, `workflow:failed`,
      etc.), and Buzz-metered billing. Bearer-token authenticated.
  - aid: civitai:civitai-oauth-api
    name: Civitai OAuth API
    tags:
      - AI
      - Artificial Intelligence
      - Authentication
      - OAuth
      - PKCE
      - Identity
    humanURL: https://developer.civitai.com/site/oauth/
    properties:
      - url: https://developer.civitai.com/site/oauth/
        type: Documentation
      - url: https://developer.civitai.com/site/oauth/register-app
        type: Documentation
      - url: https://developer.civitai.com/site/oauth/scopes
        type: Documentation
      - url: https://developer.civitai.com/site/oauth/buzz-limits
        type: Documentation
    description: >-
      OAuth 2.0 authorization-code with PKCE for third-party apps that act on behalf of a Civitai user. Supports scoped
      tokens, refresh flow, and per-app Buzz spend caps so a delegated app cannot drain a user's credit balance. Used by
      `civitai-app-starters` and `civitai-client-javascript` SDKs for building partner integrations against the Site and
      Orchestration APIs.
name: Civitai
tags:
  - AI
  - Artificial Intelligence
  - Image Generation
  - Video Generation
  - Stable Diffusion
  - SDXL
  - Flux
  - LoRA
  - Model Hosting
  - Community
  - Generative AI
kind: contract
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
access: 3rd-Party
common:
  - type: PostmanWorkspace
    url: https://www.postman.com/kinlaneapi/civitai/overview
  - type: ArazzoWorkflows
    url: arazzo/
    workflows:
      - url: arazzo/civitai-batch-hash-reconcile-workflow.yml
        name: Civitai Batch Hash Reconciliation
        summary: Resolve many file hashes to version ids in bulk, then enrich the first match with model detail.
      - url: arazzo/civitai-blob-upload-img2img-workflow.yml
        name: Civitai Blob Upload and Image-to-Image Generation
        summary: Upload a source image blob, run an img2img workflow against it, poll, and read the result.
      - url: arazzo/civitai-creator-models-gallery-workflow.yml
        name: Civitai Creator Models and Image Gallery
        summary: Find a creator, list the models they publish, and pull a gallery of images for one model.
      - url: arazzo/civitai-image-generation-poll-workflow.yml
        name: Civitai Image Generation Submit and Poll
        summary: Submit an image generation workflow, poll until it finishes, and collect the output blobs.
      - url: arazzo/civitai-model-images-explorer-workflow.yml
        name: Civitai Model Images Explorer
        summary: Open a model, browse its community images, and resolve the version behind the top image.
      - url: arazzo/civitai-model-version-by-hash-workflow.yml
        name: Civitai Identify a Model From a File Hash
        summary: Resolve a local model file's hash to its model version, then load the parent model.
      - url: arazzo/civitai-model-version-to-generation-workflow.yml
        name: Civitai Generate From a Catalog Model Version
        summary: Resolve a catalog model version's AIR, generate an image with it, poll, and read the result.
      - url: arazzo/civitai-permission-gated-download-workflow.yml
        name: Civitai Permission-Gated Version Download
        summary: Resolve a model version, check the bearer's permissions, and branch on download rights.
      - url: arazzo/civitai-presigned-blob-generate-workflow.yml
        name: Civitai Presigned Blob Upload Then Generate
        summary: Request a presigned blob upload URL, reference the blob in a workflow with webhook callbacks, and poll.
      - url: arazzo/civitai-search-models-detail-workflow.yml
        name: Civitai Search Models and Drill Into a Version
        summary: Search the model catalog, open the top matching model, and resolve one of its versions.
      - url: arazzo/civitai-tag-models-discovery-workflow.yml
        name: Civitai Tag-Driven Model Discovery
        summary: Pick a tag from the taxonomy, list models carrying that tag, and open the top model.
      - url: arazzo/civitai-vault-toggle-verify-workflow.yml
        name: Civitai Vault Add and Verify
        summary: Confirm the user, check vault capacity, add a model version to the vault, and verify storage.
      - url: arazzo/civitai-workflow-query-cancel-workflow.yml
        name: Civitai Query and Cancel a Running Workflow
        summary: List active workflows, inspect the first one, cancel it, and confirm the canceled state.
  - type: LinkedIn
    url: https://www.linkedin.com/company/civitai
  - type: Twitter
    url: https://twitter.com/HelloCivitai
  - type: GitHubOrganization
    url: https://github.com/civitai
  - type: Portal
    url: https://civitai.com
  - type: Documentation
    url: https://developer.civitai.com/
  - type: Documentation
    url: https://education.civitai.com/
  - type: GettingStarted
    url: https://developer.civitai.com/orchestration/guide/getting-started
  - type: Authentication
    url: https://developer.civitai.com/orchestration/guide/authentication
  - type: Webhooks
    url: https://developer.civitai.com/orchestration/guide/results-and-webhooks
  - type: Errors
    url: https://developer.civitai.com/orchestration/guide/errors-and-retries
  - type: SignUp
    url: https://civitai.com/login
  - type: TermsOfService
    url: https://civitai.com/content/tos
  - type: PrivacyPolicy
    url: https://civitai.com/content/privacy
  - type: ContentPolicy
    url: https://civitai.com/content/content-policy
  - type: Support
    url: https://education.civitai.com/
  - type: Blog
    url: https://civitai.com/articles
  - type: Forum
    url: https://education.civitai.com/forums/
  - url: https://github.com/civitai/civitai-client-javascript
    name: Civitai JavaScript Client
    type: SDK
  - url: https://github.com/civitai/civitai-app-starters
    name: Civitai App Starters (OAuth + PKCE SDK)
    type: SDK
  - url: https://github.com/civitai/civitai-link-desktop
    name: Civitai Link Desktop
    type: Tool
  - url: https://github.com/civitai/civitai
    name: Civitai Platform (open source)
    type: GitHubRepository
  - url: https://github.com/civitai/ai-toolkit
    name: AI Toolkit (Diffusion Finetuning)
    type: Tool
  - url: https://github.com/civitai/model-scanner
    name: Model Scanner
    type: Tool
  - url: https://github.com/civitai/ComfyUI
    name: ComfyUI (Civitai fork)
    type: Tool
  - url: https://github.com/civitai/ComfyUI_smZNodes
    name: ComfyUI smZNodes
    type: Plugins
  - url: https://github.com/civitai/bitdex
    name: Bitdex (bitmap index engine)
    type: GitHubRepository
  - url: https://developer.civitai.com/site/guide/air
    name: AI Resource Identifier (AIR)
    type: Documentation
  - url: https://developer.civitai.com/orchestration/mcp
    name: Civitai MCP Server
    type: MCPServer
  - url: https://developer.civitai.com/llms.txt
    name: LLM-friendly docs index
    type: Documentation
  - url: https://developer.civitai.com/llms-full.txt
    name: LLM-friendly full docs
    type: Documentation
  - url: plans/civitai-plans-pricing.yml
    type: Plans
  - url: rate-limits/civitai-rate-limits.yml
    type: RateLimits
  - url: finops/civitai-finops.yml
    type: FinOps
  - type: Features
    data:
      - Largest community catalog of Stable Diffusion, SDXL, and Flux checkpoints, LoRAs, embeddings, and VAEs
      - Image, video, audio, and language generation through a single Orchestration API
      - >-
        Multi-provider workflow racing across Flux 1/2, SDXL, SD1, Z-Image, Qwen, Seedream, Grok, WAN, Kling, LTX2,
        Vidu, Veo 3, HunyuanVideo
      - LoRA training jobs for SDXL, Flux, WAN, and LTX2 ecosystems
      - AI Resource Identifier (AIR) URN scheme for unambiguously referencing models, versions, and weights
      - Bearer-token authentication via per-user API keys, plus OAuth 2.0 + PKCE for third-party apps
      - In-order, serialized webhooks for workflow, step, and job lifecycle events
      - HTTPS-only webhook endpoints with retry on non-2xx; idempotency keyed on `(workflowId, status, timestamp)`
      - Blob upload API with built-in NSFW moderation and presigned upload URLs
      - Buzz credit system for metering generation, with per-app spend caps on delegated OAuth tokens
      - Civitai Vault for membership-tier model storage and retrieval via API
      - Hash-based model-version lookup for client tools (ComfyUI, A1111, Civitai Link)
      - Public MCP server exposing Civitai as tools for Claude, Cursor, and other MCP-aware agents
      - Open-source Civitai platform repo (TypeScript) on GitHub
      - Official JavaScript SDK (`civitai-client-javascript`) and OAuth SDK (`civitai-app-starters`)
      - Civitai Link Desktop for syncing models into local Stable Diffusion installs
      - AI Toolkit for diffusion model finetuning; Model Scanner for safety/security checks
      - Education portal and community articles, posts, comics, challenges, and bounties
    sources:
      - https://developer.civitai.com/
      - https://developer.civitai.com/site/reference/
      - https://developer.civitai.com/orchestration/reference/
      - https://developer.civitai.com/orchestration/recipes/
      - https://github.com/civitai
    updated: '2026-05-25'
created: '2026-05-25'
modified: '2026-05-25'
position: Producing
description: >-
  Civitai is the largest open community for Stable Diffusion, SDXL, Flux, and video AI models — hosting over a million
  model checkpoints, LoRAs, embeddings, and VAEs uploaded and rated by creators. Beyond hosting, Civitai operates a
  hosted AI image, video, audio, and language generation service through its Orchestration API, which races workflows
  across providers (Flux 1/2, SDXL, SD1, Z-Image, Qwen, Seedream, Grok, WAN 2.1-2.7, Kling, LTX2, Vidu, Veo 3,
  HunyuanVideo) and supports LoRA training jobs. The Site API exposes the public catalog plus user vault, permissions,
  and AIR identifier resolution. OAuth 2.0 with PKCE and per-app Buzz spend caps lets third parties build delegated
  experiences without owning a user's full credit balance. Generation is metered in Buzz, a virtual credit topped up via
  memberships or one-off packs.
maintainers:
  - FN: Kin Lane
    email: info@apievangelist.com
    X: apievangelist
    url: https://apievangelist.com
specificationVersion: '0.16'