civai-co

civai-co Research API

The research API from civai-co — 12 operation(s) for research.

Documentation GitHub OpenAPI

Operations 14

POST /api/projects/{project_id}/research/generate Generate Research #

GET /api/projects/{project_id}/research/status Get Research Status #

GET /api/projects/{project_id}/research/reports List Research Reports #

GET /api/projects/{project_id}/research/reports/{filename} Get Research Report #

GET /api/projects/{project_id}/research/reports/{filename}/pdf Download Report As Pdf #

POST /api/projects/{project_id}/research/sections/{section_id}/regenerate Regenerate Section #

GET /api/projects/{project_id}/research/drive List Project Drive #

POST /api/projects/{project_id}/research/drive/upload Upload Project Drive File #

GET /api/projects/{project_id}/research/drive/text Get Project Drive File Text Query #

PUT /api/projects/{project_id}/research/drive/text Put Project Drive File Text Query #

GET /api/projects/{project_id}/research/drive/{file_id}/text Get Project Drive File Text #

PUT /api/projects/{project_id}/research/drive/{file_id}/text Put Project Drive File Text #

GET /api/projects/{project_id}/research/drive/download Download Project Drive File #

GET /api/projects/{project_id}/research/drive/media/{file_path} Serve Project Drive Media #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/civai-co/openapi/civai-co-research-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-research-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

openapi: 3.2.0
info:
  title: Civai Co Research API
  version: 1.0.0
  description: 'Operations tagged research 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: Research
paths:
  /api/projects/{project_id}/research/generate:
    post:
      tags:
      - Research
      summary: Generate Research
      description: 'Start research generation (async background task).


        See plan.md section 2.3.1 for requirements.'
      operationId: generate_research_api_projects__project_id__research_generate_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/GenerateResearchRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/research/status:
    get:
      tags:
      - Research
      summary: Get Research Status
      description: 'Get research generation status.


        See plan.md section 2.3.1 for requirements.'
      operationId: get_research_status_api_projects__project_id__research_status_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project 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}/research/reports:
    get:
      tags:
      - Research
      summary: List Research Reports
      description: 'List all available research reports.


        See plan.md section 2.3.1 for requirements.'
      operationId: list_research_reports_api_projects__project_id__research_reports_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project 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}/research/reports/{filename}:
    get:
      tags:
      - Research
      summary: Get Research Report
      description: 'Get content of a specific research report.


        See plan.md section 2.3.1 for requirements.'
      operationId: get_research_report_api_projects__project_id__research_reports__filename__get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: filename
        in: path
        required: true
        schema:
          type: string
          title: Filename
      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}/research/reports/{filename}/pdf:
    get:
      tags:
      - Research
      summary: Download Report As Pdf
      description: 'Download a research report as PDF.


        Args:

        project_id: Project ID

        filename: Report filename (e.g., "report.md")


        Returns:

        PDF file as binary response'
      operationId: download_report_as_pdf_api_projects__project_id__research_reports__filename__pdf_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: filename
        in: path
        required: true
        schema:
          type: string
          title: Filename
      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}/research/sections/{section_id}/regenerate:
    post:
      tags:
      - Research
      summary: Regenerate Section
      description: 'Regenerate a single report section.


        Args:

        project_id: Project ID

        section_id: Section ID to regenerate (e.g., "audience_vocabulary", "pain_points")


        Returns:

        Status response'
      operationId: regenerate_section_api_projects__project_id__research_sections__section_id__regenerate_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: section_id
        in: path
        required: true
        schema:
          type: string
          title: Section Id
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/research/drive:
    get:
      tags:
      - Research
      summary: List Project Drive
      description: 'List Files drive entries: research reports + context uploads.'
      operationId: list_project_drive_api_projects__project_id__research_drive_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project 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}/research/drive/upload:
    post:
      tags:
      - Research
      summary: Upload Project Drive File
      description: Upload a guide/media file into output_dir/context/.
      operationId: upload_project_drive_file_api_projects__project_id__research_drive_upload_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_project_drive_file_api_projects__project_id__research_drive_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}/research/drive/text:
    get:
      tags:
      - Research
      summary: Get Project Drive File Text Query
      description: Return plain text for a document drive file (query param avoids path slash encoding issues).
      operationId: get_project_drive_file_text_query_api_projects__project_id__research_drive_text_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: file_id
        in: query
        required: true
        schema:
          type: string
          description: Drive file id (report:… or context:…)
          title: File Id
        description: Drive file id (report:… or context:…)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Research
      summary: Put Project Drive File Text Query
      description: Save markdown or plain-text drive files (file_id query param).
      operationId: put_project_drive_file_text_query_api_projects__project_id__research_drive_text_put
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: file_id
        in: query
        required: true
        schema:
          type: string
          description: Drive file id
          title: File Id
        description: Drive file id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DriveTextPutBody'
      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}/research/drive/{file_id}/text:
    get:
      tags:
      - Research
      summary: Get Project Drive File Text
      description: Return plain text for a document drive file (legacy path param).
      operationId: get_project_drive_file_text_api_projects__project_id__research_drive__file_id__text_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Research
      summary: Put Project Drive File Text
      description: Save markdown or plain-text drive files from the Files editor (legacy path param).
      operationId: put_project_drive_file_text_api_projects__project_id__research_drive__file_id__text_put
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DriveTextPutBody'
      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}/research/drive/download:
    get:
      tags:
      - Research
      summary: Download Project Drive File
      description: Download any drive file (PDF, md, images, etc.) with correct filename.
      operationId: download_project_drive_file_api_projects__project_id__research_drive_download_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: file_id
        in: query
        required: true
        schema:
          type: string
          description: Drive file id (report:… or context:…)
          title: File Id
        description: Drive file id (report:… or context:…)
      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}/research/drive/media/{file_path}:
    get:
      tags:
      - Research
      summary: Serve Project Drive Media
      description: Serve image/video (or any) drive file for preview; auth required.
      operationId: serve_project_drive_media_api_projects__project_id__research_drive_media__file_path__get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      - name: file_path
        in: path
        required: true
        schema:
          type: string
          title: File Path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GenerateResearchRequest:
      properties:
        require_product_name_in_queries:
          type: boolean
          title: Require Product Name In Queries
          default: false
        report_only:
          type: boolean
          title: Report Only
          default: false
        included_sections:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Included Sections
      type: object
      title: GenerateResearchRequest
    DriveTextPutBody:
      properties:
        text:
          type: string
          title: Text
      type: object
      required:
      - text
      title: DriveTextPutBody
    Body_upload_project_drive_file_api_projects__project_id__research_drive_upload_post:
      properties:
        file:
          type: string
          format: binary
          title: File
      type: object
      required:
      - file
      title: Body_upload_project_drive_file_api_projects__project_id__research_drive_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
    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