CoreStory Version API

openapi: 3.2.0
info:
  title: Crowdbotics API Documentation Version 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: Version
paths:
  /api/version:
    get:
      tags:
      - Version
      summary: Get application version information
      description: 'Retrieve the current application version and build information.


        This endpoint provides version information that can be used for:

        * Verifying deployments and identifying specific builds

        * Debugging issues and ensuring compatibility

        * Monitoring and tracking application versions across environments


        The endpoint returns different information based on the deployment context:

        * **Docker builds**: Includes build timestamp and additional metadata from build.json

        * **Local development**: Returns dev placeholder with build_type ''local''


        **Performance**: This endpoint is optimized for speed with in-memory caching and

        typically responds in under 100ms. No database operations are performed.


        **Authentication**: This endpoint does not require authentication and is publicly accessible.'
      operationId: get_version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
        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.
      type: object
      required:
      - message
      - type
      title: ErrorBody
    ErrorSchema:
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      type: object
      required:
      - error
      title: ErrorSchema
    VersionResponse:
      properties:
        version:
          type: string
          maxLength: 200
          minLength: 1
          title: Version
          description: Application version from build.json or dev placeholder
          example: 1.2.3
        build_timestamp:
          anyOf:
          - type: string
          - type: 'null'
          title: Build Timestamp
          description: ISO 8601 timestamp when the build was created (Docker builds only)
          example: '2024-10-10T15:30:45Z'
        build_type:
          $ref: '#/components/schemas/BuildType'
          description: 'Build context: ''docker'' for containerized builds, ''local'' for development'
          example: docker
        additional_info:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Additional Info
          description: Additional build metadata when available (git commit, build number, etc.)
          example:
            build_number: '123'
            git_commit: a1b2c3d4e5f6
            github_run_id: '456789'
      type: object
      required:
      - version
      - build_type
      title: VersionResponse
      description: 'Response model for version information.


        This model represents the standardized response format for version endpoints,

        supporting both Docker containerized builds and local development environments.'
      examples:
      - additional_info:
          build_number: '123'
          git_commit: a1b2c3d4e5f6
          github_run_id: '456789'
        build_timestamp: '2024-10-10T15:30:45Z'
        build_type: docker
        version: 1.2.3
      - build_type: local
        version: 0.0.0-dev
    BuildType:
      type: string
      enum:
      - docker
      - local
      title: BuildType
      description: Enumeration of supported build types.
  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