CoreStory Quality Metrics API

openapi: 3.2.0
info:
  title: Crowdbotics API Documentation Quality Metrics API
  description: '# CoreStory API Overview


    The CoreStory API provides programmatic access to structured insights derived from software source code.'
  version: 1.26.2
servers:
- url: /
  description: Current server
security:
- BearerAuth: []
tags:
- name: quality_metrics
paths:
  /api/quality-metrics/{project_id}/generate:
    post:
      tags:
      - quality_metrics
      summary: Start Generating Quality Metrics for given artifacts in the background
      operationId: generate_quality_metrics
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: coverage_metrics_only
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to generate only coverage metrics or full quality metrics
          default: true
          title: Coverage Metrics Only
        description: Whether to generate only coverage metrics or full quality metrics
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_generate_quality_metrics'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Generate Quality Metrics
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Internal Server Error
  /api/quality-metrics/{project_id}:
    get:
      tags:
      - quality_metrics
      summary: Get quality metrics results
      description: Retrieve quality metrics evaluation results for a project. Supports JSON and CSV output formats.
      operationId: get_quality_metrics
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: format
        in: query
        required: false
        schema:
          enum:
          - json
          - csv
          type: string
          description: The format of the generated document
          default: json
          title: Format
        description: The format of the generated document
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Internal Server Error
  /api/quality-metrics/validate-doc:
    post:
      tags:
      - quality_metrics
      summary: Validate a document
      description: Validate a PRD or Tech Spec document against quality standards. Upload the document file and specify the type.
      operationId: validate_document
      parameters:
      - name: doc_type
        in: query
        required: false
        schema:
          enum:
          - prd
          - tech_spec
          type: string
          description: Type of doc either 'prd' or 'tech_spec'
          default: prd
          title: Doc Type
        description: Type of doc either 'prd' or 'tech_spec'
      - name: lines_of_code
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Lines Of Code
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_validate_document'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Internal Server Error
components:
  schemas:
    ErrorBody:
      properties:
        message:
          type: string
          title: Message
        type:
          type: string
          title: Type
        details:
          additionalProperties: true
          type: object
          title: Details
          description: Optional extra context for the error.
      type: object
      required:
      - message
      - type
      title: ErrorBody
    Body_validate_document:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
          description: File containing PRD or Tech Spec artifacts
      type: object
      required:
      - file
      title: Body_validate_document
    ErrorSchema:
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      type: object
      required:
      - error
      title: ErrorSchema
    Body_generate_quality_metrics:
      properties:
        prd_file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: string
          title: Prd File
          description: JSON file containing PRD artifacts
          default: ''
        tech_spec_file:
          anyOf:
          - type: string
            contentMediaType: application/octet-stream
          - type: string
          title: Tech Spec File
          description: JSON file containing Tech Specs
          default: ''
      type: object
      title: Body_generate_quality_metrics
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter the Bearer token from Clerk authentication
x-tagGroups:
- name: Ingest Your Codebase
  tags:
  - vector_store
  - projects
  - pre_ingestion
  - reingestion
- name: Generate Code Intelligence
  tags:
  - documents
  - document_generation
  - document_formatters
  - prd
  - prd_version
  - tech_spec
  - quality_metrics
  - sample_projects
- name: Query Your Codebase
  tags:
  - conversations
  - workflows
  - discovery
  - context
  - artifacts
- name: Manage and Inspect Intelligence
  tags:
  - api_debugging
  - events
  - version
  - files
  - cache
  - token_tracking
- name: Authenticate and Manage Access
  tags:
  - clerk_authentication
  - github_webhooks
  - github_integration
  - organizations
  - api_key_management
  - mcp_token_management
  - user
- name: (Advanced) Prompt Tuning
  tags:
  - prompts
- name: MCP Protocol
  tags:
  - mcp_protocol
- name: Administration
  tags:
  - admin