CoreStory Usage API

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


    The CoreStory API provides programmatic access to structured insights derived from software source code. It is designed for engineering, architecture, and product teams who need to extract business logic, technical specifications, architectural relationships, and system-level context from complex or legacy codebases. By interfacing directly with CoreStory API, users can:


    - Generate full Product Requirements Documents (PRDs) from a codebase

    - Extract detailed Technical Specifications for modernization or migration

    - Query a codebase using natural language to surface implementation details, logic paths, dependencies, and architectural insights

    - Construct and visualize knowledge graphs of systems, components, and relationships

    - Ingest, store, and retrieve content from a vector store for AI-powered retrieval-augmented generation (RAG) workflows


    CoreStory is especially valuable in contexts where:


    - Codebases are large, unstructured, or under-documented

    - Product and engineering teams are onboarding to unfamiliar systems

    - Technical stakeholders require visibility into system design or feature coverage

    - Modernization, replatforming, or M&A due diligence is underway


    The API can be integrated into existing CI/CD pipelines, internal developer portals, architecture review boards, product planning processes, or documentation automation workflows. All endpoints support secure authentication and are designed for high-availability, asynchronous workloads. Output formats include JSON, Markdown, and PDF, with flexible formatting options for downstream consumption. For step-by-step usage instructions and workflows, refer to the CoreStory API Quick Start Guide. ## Features


    * **Document Generation**

    * Generate complete Product Requirements Documents (PRD)

    * Generate Technical Specifications

    * Generate individual document sections (executive overview, user personas, etc.)

    * Format documents in JSON or Markdown


    * **Vector Store Management**

    * Ingest and manage documents in vector store

    * Query and retrieve document content

    * Manage document embeddings


    * **Context Management**

    * Manage context for different document types

    * Set and retrieve PRD context

    * Support for future context types (technical specs, user stories, etc.)


    * **Knowledge Graph**

    * Generate knowledge graphs from codebase queries

    * Visualize relationships between code entities

    * Analyze code structure and dependencies


    * **API Endpoints**

    * `/api/documents/*` - Document generation and formatting

    * `/api/generate/*` - Document formatting utilities

    * `/api/vector-store/*` - Vector store management

    * `/api/agents/*` - AI agent operations

    * `/api/context/*` - Context management for documents

    * `/api/graph/*` - Knowledge graph generation and analysis


    Note: JWT authentication support coming soon. All endpoints currently provide detailed OpenAPI documentation. * **Observability**

    * OpenTelemetry instrumentation for distributed tracing

    * Prometheus metrics endpoint at `/metrics`

    * Comprehensive request/response tracking

    * Custom business metrics


    # CoreStory System Architecture


    This document provides a high-level overview of how the CoreStory platform ingests, analyzes, and serves structured software intelligence through its API. The system is designed to process codebases and related technical artifacts in order to generate product specifications, technical documents, and knowledge graph representations. ---


    ## Core Components


    ### 1. **Ingestion Layer**


    - Accepts Git URLs, file uploads, or local archives

    - Extracts source files, documentation, and metadata

    - Initiates chunking and embedding via the vector store pipeline


    ### 2. **Vector Store and Context Engine**


    - Stores chunked and embedded documents

    - Supports semantic search and document retrieval

    - Feeds LLMs with scoped context for generation and reasoning


    ### 3.'
  version: 1.33.0
servers:
- url: /
  description: Current server
security:
- BearerAuth: []
tags:
- name: Usage
paths:
  /api/usage:
    get:
      tags:
      - Usage
      summary: Get Usage
      description: Current CIU, lines-of-code, and codebase usage for the authenticated organization.
      operationId: get_usage
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
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.
        code:
          anyOf:
          - type: string
          - type: 'null'
          title: Code
          description: Stable machine-readable code for clients that branch on the specific failure.
        required_organization:
          anyOf:
          - $ref: '#/components/schemas/RequiredOrganization'
          - type: 'null'
          description: Set when the caller can retry after switching organization context.
      type: object
      required:
      - message
      - type
      title: ErrorBody
    ProjectUsage:
      properties:
        count:
          type: integer
          title: Count
          description: Number of projects (codebases) in the organization
        limit:
          type: integer
          title: Limit
          description: The plan's project limit; 0 means unlimited
      type: object
      required:
      - count
      - limit
      title: ProjectUsage
      description: Codebase count against the plan's project limit.
    UsageResponse:
      properties:
        plan_tier:
          type: string
          title: Plan Tier
          description: 'Customer-facing plan family: free / pro / business / enterprise'
        ciu:
          $ref: '#/components/schemas/CIUUsage'
          description: Compute-intelligence-unit usage this cycle
        loc:
          $ref: '#/components/schemas/LOCUsageBlock'
          description: Lines-of-code usage (lifetime, append-only)
        projects:
          $ref: '#/components/schemas/ProjectUsage'
          description: Codebase count against the plan limit
      type: object
      required:
      - plan_tier
      - ciu
      - loc
      - projects
      title: UsageResponse
      description: Current usage for the requesting organization, across every metered dimension.
    RequiredOrganization:
      properties:
        id:
          type: string
          title: Id
          description: Clerk organization id the client should switch to.
        name:
          type: string
          title: Name
          description: Display name of that organization.
      type: object
      required:
      - id
      - name
      title: RequiredOrganization
      description: The organization a caller must be acting under before a denied request can succeed.
    CIUUsage:
      properties:
        consumed:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Consumed
          description: CIUs consumed in the current cycle
        total:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Total
          description: CIUs allocated for the current cycle
        available:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Available
          description: Remaining CIUs (total - consumed)
        reset_date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Reset Date
          description: When the monthly CIU allowance next resets. Null when the plan does not renew.
        near_limit:
          type: boolean
          title: Near Limit
          description: Consumption has crossed the near-limit threshold
        blocked:
          type: boolean
          title: Blocked
          description: Allowance is exhausted (no CIUs available)
      type: object
      required:
      - consumed
      - total
      - available
      - near_limit
      - blocked
      title: CIUUsage
      description: 'Compute-intelligence-unit meter for the current cycle.


        A single number against the monthly allowance.'
    LOCUsageBlock:
      properties:
        consumed:
          type: integer
          title: Consumed
          description: Total lines of code consumed across all ingestions
        allowance:
          type: integer
          title: Allowance
          description: Current lines-of-code allowance for the organization
        remaining:
          type: integer
          title: Remaining
          description: Headroom (allowance - consumed), floored at 0
        near_limit:
          type: boolean
          title: Near Limit
          description: Consumption has crossed the near-limit threshold
        blocked:
          type: boolean
          title: Blocked
          description: Allowance is fully consumed
      type: object
      required:
      - consumed
      - allowance
      - remaining
      - near_limit
      - blocked
      title: LOCUsageBlock
      description: 'Lines-of-code meter.


        Append-only across all uploads: consumed never decreases and never resets.

        The allowance only moves upward, via upgrade or an admin grant.'
    ErrorSchema:
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      type: object
      required:
      - error
      title: ErrorSchema
  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
  - git_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
x-provenance:
  method: harvested
  publisher: CoreStory
  source: https://c2s.corestory.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)