civai-co

civai-co Document Assets API

The document-assets API from civai-co — 8 operation(s) for document-assets.

GitHub OpenAPI

Operations 9

POST /api/projects/{project_id}/assets/documents/import Start Document Import #
PUT /api/projects/{project_id}/assets/documents/{asset_id}/upload Upload Document Source #
POST /api/projects/{project_id}/assets/documents/upload Upload Document #
GET /api/projects/{project_id}/assets/documents/{asset_id} Get Document Asset #
POST /api/projects/{project_id}/assets/documents/{asset_id}/layerize Layerize Document #
POST /api/projects/{project_id}/assets/documents/{asset_id}/pages/{page_index}/layer-design/cancel Cancel Document Page Layerize #
GET /api/projects/{project_id}/assets/documents/{asset_id}/pages/{page_index}/layer-design Get Document Page Layer Design #
PUT /api/projects/{project_id}/assets/documents/{asset_id}/pages/{page_index}/layer-design Update Document Page Layer Design #
POST /api/projects/{project_id}/assets/documents/{asset_id}/export Export Document #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/civai-co/openapi/civai-co-document-assets-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/civai-co/json-schema/civai-co-generate-image-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/civai-co/json-schema/civai-co-patch-row-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/civai-co/json-schema/civai-co-create-row-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/civai-co/json-schema/civai-co-ad-plan-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/civai-co/json-schema/civai-co-ad-plan-update-schema.json
📊
JSONSchema
https://artifacts.apis.io/civai-co/json-schema/civai-co-project-create-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/civai-co:civai-co-document-assets-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

civai-co-document-assets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Civai Co Document Assets API
  version: 1.0.0
  description: 'Operations tagged document-assets across 2 of this provider''s published API definitions: audience-resolver-api.civai.co-openapi.json, audience-resolver-api.civai.co-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: document-assets
paths:
  /api/projects/{project_id}/assets/documents/import:
    post:
      tags:
      - document-assets
      summary: Start Document Import
      description: Create a document asset in `uploading` state; client uploads bytes next.
      operationId: start_document_import_api_projects__project_id__assets_documents_import_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartDocumentImportBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/assets/documents/{asset_id}/upload:
    put:
      tags:
      - document-assets
      summary: Upload Document Source
      description: Receive file bytes, then run raster import in the background.
      operationId: upload_document_source_api_projects__project_id__assets_documents__asset_id__upload_put
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_document_source_api_projects__project_id__assets_documents__asset_id__upload_put'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/assets/documents/upload:
    post:
      tags:
      - document-assets
      summary: Upload Document
      operationId: upload_document_api_projects__project_id__assets_documents_upload_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_document_api_projects__project_id__assets_documents_upload_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/assets/documents/{asset_id}:
    get:
      tags:
      - document-assets
      summary: Get Document Asset
      operationId: get_document_asset_api_projects__project_id__assets_documents__asset_id__get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/assets/documents/{asset_id}/layerize:
    post:
      tags:
      - document-assets
      summary: Layerize Document
      operationId: layerize_document_api_projects__project_id__assets_documents__asset_id__layerize_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LayerizeDocumentBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/assets/documents/{asset_id}/pages/{page_index}/layer-design/cancel:
    post:
      tags:
      - document-assets
      summary: Cancel Document Page Layerize
      operationId: cancel_document_page_layerize_api_projects__project_id__assets_documents__asset_id__pages__page_index__layer_design_cancel_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      - name: page_index
        in: path
        required: true
        schema:
          type: integer
          title: Page Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/assets/documents/{asset_id}/pages/{page_index}/layer-design:
    get:
      tags:
      - document-assets
      summary: Get Document Page Layer Design
      operationId: get_document_page_layer_design_api_projects__project_id__assets_documents__asset_id__pages__page_index__layer_design_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      - name: page_index
        in: path
        required: true
        schema:
          type: integer
          title: Page Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - document-assets
      summary: Update Document Page Layer Design
      operationId: update_document_page_layer_design_api_projects__project_id__assets_documents__asset_id__pages__page_index__layer_design_put
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      - name: page_index
        in: path
        required: true
        schema:
          type: integer
          title: Page Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/assets/documents/{asset_id}/export:
    post:
      tags:
      - document-assets
      summary: Export Document
      operationId: export_document_api_projects__project_id__assets_documents__asset_id__export_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportDocumentBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExportDocumentBody:
      properties:
        format:
          type: string
          title: Format
      type: object
      required:
      - format
      title: ExportDocumentBody
    LayerizeDocumentBody:
      properties:
        page_index:
          anyOf:
          - type: integer
          - type: 'null'
          title: Page Index
      type: object
      title: LayerizeDocumentBody
    Body_upload_document_source_api_projects__project_id__assets_documents__asset_id__upload_put:
      properties:
        file:
          type: string
          format: binary
          title: File
      type: object
      required:
      - file
      title: Body_upload_document_source_api_projects__project_id__assets_documents__asset_id__upload_put
    Body_upload_document_api_projects__project_id__assets_documents_upload_post:
      properties:
        file:
          anyOf:
          - type: string
            format: binary
          - type: 'null'
          title: File
        files:
          anyOf:
          - items:
              type: string
              format: binary
            type: array
          - type: 'null'
          title: Files
        caption:
          anyOf:
          - type: string
          - type: 'null'
          title: Caption
      type: object
      title: Body_upload_document_api_projects__project_id__assets_documents_upload_post
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    StartDocumentImportBody:
      properties:
        filename:
          type: string
          title: Filename
        caption:
          anyOf:
          - type: string
          - type: 'null'
          title: Caption
      type: object
      required:
      - filename
      title: StartDocumentImportBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
x-refined-from:
- audience-resolver-api.civai.co-openapi.json
- audience-resolver-api.civai.co-openapi.json