civai-co

civai-co Publisher Research API

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

GitHub OpenAPI

Operations 14

POST /api/publisher/projects/{project_id}/research/generate Publisher Generate Research #
GET /api/publisher/projects/{project_id}/research/status Publisher Research Status #
GET /api/publisher/projects/{project_id}/research/reports Publisher List Reports #
GET /api/publisher/projects/{project_id}/research/reports/{filename} Publisher Get Report #
GET /api/publisher/projects/{project_id}/research/reports/{filename}/pdf Publisher Report Pdf #
POST /api/publisher/projects/{project_id}/research/sections/{section_id}/regenerate Publisher Regenerate Section #
GET /api/publisher/projects/{project_id}/research/drive Publisher List Drive #
POST /api/publisher/projects/{project_id}/research/drive/upload Publisher Upload Drive #
GET /api/publisher/projects/{project_id}/research/drive/text Publisher Drive Text Query #
PUT /api/publisher/projects/{project_id}/research/drive/text Publisher Put Drive Text Query #
GET /api/publisher/projects/{project_id}/research/drive/{file_id}/text Publisher Drive Text #
PUT /api/publisher/projects/{project_id}/research/drive/{file_id}/text Publisher Put Drive Text #
GET /api/publisher/projects/{project_id}/research/drive/download Publisher Drive Download #
GET /api/publisher/projects/{project_id}/research/drive/media/{file_path} Publisher Drive Media #

Specifications

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

civai-co-publisher-research-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Civai Co Publisher Research API
  version: 1.0.0
  description: 'Operations tagged publisher-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: publisher-research
paths:
  /api/publisher/projects/{project_id}/research/generate:
    post:
      tags:
      - publisher-research
      summary: Publisher Generate Research
      operationId: publisher_generate_research_api_publisher_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/publisher/projects/{project_id}/research/status:
    get:
      tags:
      - publisher-research
      summary: Publisher Research Status
      operationId: publisher_research_status_api_publisher_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/publisher/projects/{project_id}/research/reports:
    get:
      tags:
      - publisher-research
      summary: Publisher List Reports
      operationId: publisher_list_reports_api_publisher_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/publisher/projects/{project_id}/research/reports/{filename}:
    get:
      tags:
      - publisher-research
      summary: Publisher Get Report
      operationId: publisher_get_report_api_publisher_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/publisher/projects/{project_id}/research/reports/{filename}/pdf:
    get:
      tags:
      - publisher-research
      summary: Publisher Report Pdf
      operationId: publisher_report_pdf_api_publisher_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/publisher/projects/{project_id}/research/sections/{section_id}/regenerate:
    post:
      tags:
      - publisher-research
      summary: Publisher Regenerate Section
      operationId: publisher_regenerate_section_api_publisher_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/publisher/projects/{project_id}/research/drive:
    get:
      tags:
      - publisher-research
      summary: Publisher List Drive
      operationId: publisher_list_drive_api_publisher_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/publisher/projects/{project_id}/research/drive/upload:
    post:
      tags:
      - publisher-research
      summary: Publisher Upload Drive
      operationId: publisher_upload_drive_api_publisher_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_publisher_upload_drive_api_publisher_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/publisher/projects/{project_id}/research/drive/text:
    get:
      tags:
      - publisher-research
      summary: Publisher Drive Text Query
      operationId: publisher_drive_text_query_api_publisher_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
          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:
      - publisher-research
      summary: Publisher Put Drive Text Query
      operationId: publisher_put_drive_text_query_api_publisher_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
          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/publisher/projects/{project_id}/research/drive/{file_id}/text:
    get:
      tags:
      - publisher-research
      summary: Publisher Drive Text
      operationId: publisher_drive_text_api_publisher_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:
      - publisher-research
      summary: Publisher Put Drive Text
      operationId: publisher_put_drive_text_api_publisher_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/publisher/projects/{project_id}/research/drive/download:
    get:
      tags:
      - publisher-research
      summary: Publisher Drive Download
      operationId: publisher_drive_download_api_publisher_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
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/publisher/projects/{project_id}/research/drive/media/{file_path}:
    get:
      tags:
      - publisher-research
      summary: Publisher Drive Media
      operationId: publisher_drive_media_api_publisher_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_publisher_upload_drive_api_publisher_projects__project_id__research_drive_upload_post:
      properties:
        file:
          type: string
          format: binary
          title: File
      type: object
      required:
      - file
      title: Body_publisher_upload_drive_api_publisher_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