> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Project Digest

> Everything the project holds, from its records alone: counts, names, JSON keys
and analysis columns, plus the same facts rendered as markdown for a prompt.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json get /projects/{project_id}/digest
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /projects/{project_id}/digest:
    get:
      tags:
        - dashboards
      summary: Project Digest
      description: >-
        Everything the project holds, from its records alone: counts, names,
        JSON keys

        and analysis columns, plus the same facts rendered as markdown for a
        prompt.
      operationId: project_digest_projects__project_id__digest_get
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectDigest'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProjectDigest:
      properties:
        fingerprint:
          type: string
          title: Fingerprint
        generated_at:
          type: string
          format: date-time
          title: Generated At
        text:
          type: string
          title: Text
        instances:
          $ref: '#/components/schemas/DigestInstances'
        cellSpecifications:
          $ref: '#/components/schemas/DigestCellSpecifications'
        measurements:
          $ref: '#/components/schemas/DigestMeasurements'
        analyses:
          $ref: '#/components/schemas/DigestAnalyses'
        materials:
          $ref: '#/components/schemas/DigestMaterials'
        materialProperties:
          $ref: '#/components/schemas/DigestMaterialProperties'
        simulations:
          $ref: '#/components/schemas/DigestSimulations'
        described:
          $ref: '#/components/schemas/DigestDescribed'
      type: object
      required:
        - fingerprint
        - generated_at
        - text
      title: ProjectDigest
      description: >-
        Everything a project holds, in the shape an authoring turn needs up
        front.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DigestInstances:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        batches:
          items:
            type: string
          type: array
          title: Batches
        measured_properties_keys:
          items:
            type: string
          type: array
          title: Measured Properties Keys
      type: object
      title: DigestInstances
    DigestCellSpecifications:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        names:
          items:
            type: string
          type: array
          title: Names
        ratings_keys:
          items:
            type: string
          type: array
          title: Ratings Keys
        properties_keys:
          items:
            type: string
          type: array
          title: Properties Keys
      type: object
      title: DigestCellSpecifications
    DigestMeasurements:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        by_type:
          additionalProperties:
            type: integer
          type: object
          title: By Type
        per_instance:
          anyOf:
            - $ref: '#/components/schemas/DigestSpread'
            - type: 'null'
        properties_keys:
          items:
            type: string
          type: array
          title: Properties Keys
        recorded_duration_s:
          anyOf:
            - $ref: '#/components/schemas/DigestRange'
            - type: 'null'
      type: object
      title: DigestMeasurements
    DigestAnalyses:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        by_type:
          additionalProperties:
            type: integer
          type: object
          title: By Type
        columns_by_type:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Columns By Type
      type: object
      title: DigestAnalyses
    DigestMaterials:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        names:
          items:
            type: string
          type: array
          title: Names
      type: object
      title: DigestMaterials
    DigestMaterialProperties:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        names:
          items:
            type: string
          type: array
          title: Names
        columns_by_name:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Columns By Name
      type: object
      title: DigestMaterialProperties
    DigestSimulations:
      properties:
        count:
          type: integer
          title: Count
          default: 0
        metrics_keys:
          items:
            type: string
          type: array
          title: Metrics Keys
      type: object
      title: DigestSimulations
    DigestDescribed:
      properties:
        measurements_with_steps:
          anyOf:
            - type: integer
            - type: 'null'
          title: Measurements With Steps
        measurements_with_cycles:
          anyOf:
            - type: integer
            - type: 'null'
          title: Measurements With Cycles
        of:
          type: integer
          title: Of
          default: 0
      type: object
      title: DigestDescribed
      description: >-
        What the ``describe`` cache already knows, so the agent can skip
        re-reading it.


        The counts are null until something has been described in this project.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    DigestSpread:
      properties:
        min:
          type: integer
          title: Min
          default: 0
        max:
          type: integer
          title: Max
          default: 0
        mean:
          type: number
          title: Mean
          default: 0
      type: object
      title: DigestSpread
      description: How many measurements the busiest and quietest instance carries.
    DigestRange:
      properties:
        min:
          anyOf:
            - type: number
            - type: 'null'
          title: Min
        max:
          anyOf:
            - type: number
            - type: 'null'
          title: Max
      type: object
      title: DigestRange

````