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

# Read prompt-set analysis

> Read the latest or selected analysis, paginated assessments and proposals, latest completed run identity, and credit state. Reads never reserve or settle credits or apply proposals. Pin runId when following nextOffset. Interactive review is available in-app; Slack execution is unsupported.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/prompt-set-analysis
openapi: 3.1.0
info:
  title: DevTune API
  version: 2.0.0
  description: >-
    API for programmatic access to your AI visibility data, webhook
    subscriptions, and automation workflows. Use this API to integrate DevTune
    data into CI/CD pipelines, BI tools, AI agents, and operational systems.
servers:
  - url: https://devtune.ai/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /projects/{projectId}/prompt-set-analysis:
    get:
      summary: Read prompt-set analysis
      description: >-
        Read the latest or selected analysis, paginated assessments and
        proposals, latest completed run identity, and credit state. Reads never
        reserve or settle credits or apply proposals. Pin runId when following
        nextOffset. Interactive review is available in-app; Slack execution is
        unsupported.
      operationId: getPromptSetAnalysis
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: runId
          in: query
          schema:
            type: string
            format: uuid
        - name: offset
          in: query
          description: >-
            Requires runId when greater than zero. Applies to assessments and
            proposals independently.
          schema:
            type: integer
            minimum: 0
            maximum: 100000
            default: 0
        - name: pageSize
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Analysis and credit state; run is null when none exists.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      run:
                        type:
                          - object
                          - 'null'
                        description: >-
                          Persisted analysis run. assessments contains at most
                          pageSize items.
                        properties:
                          id:
                            type: string
                            format: uuid
                          status:
                            type: string
                            enum:
                              - queued
                              - running
                              - completed
                              - failed
                          assessments:
                            type: array
                            maxItems: 100
                            items:
                              type: object
                          estimated_credits:
                            type: number
                          prompt_count:
                            type: integer
                          failure_message:
                            type:
                              - string
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          completed_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                      proposals:
                        type: array
                        maxItems: 100
                        items:
                          type: object
                          description: >-
                            Persisted proposal including id, run_id,
                            proposal_type, state, source_prompt_id, old_text,
                            proposed_text, topic_id and applied_prompt_id.
                      nextOffset:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          Null when both assessment and proposal pages are
                          exhausted.
                      latestCompletedAnalysis:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            format: uuid
                          completed_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                      creditState:
                        type: object
                        properties:
                          availableCredits:
                            type: number
                            description: >-
                              Spendable account-wide balance; shared across
                              projects.
                          meteredCredits:
                            type:
                              - number
                              - 'null'
                            description: >-
                              Persisted settlement for the selected run; null
                              while unavailable.
                          promptCount:
                            type: integer
                          estimatedCredits:
                            type: number
                            description: >-
                              Current estimate for active prompts in active
                              topics; reservations are rechecked at start.
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitExceededError'
components:
  responses:
    BadRequestError:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFoundError:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceededError:
      description: Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        status:
          type: integer
      required:
        - error
        - message
        - status
  headers:
    X-RateLimit-Limit:
      description: Maximum requests per window
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in current window
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the window resets
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key with dtk_live_ prefix. Obtain it from API Keys in the account
        sidebar. New keys start with all supported scopes selected for the
        chosen project, and you can narrow them to specific read/write scopes as
        needed.

````