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

# Poll a client report

> Status, tier, and report URL for one client report in the workspace. Does not return the report payload - use the export.




## OpenAPI

````yaml /api-reference/openapi.yaml get /api/agent/agency/reports/{id}
openapi: 3.1.0
info:
  title: Preuve Agent API
  version: '2.0'
  description: >
    API for programmatic startup idea validation. Every request carries a single
    x-preuve-key header holding the whole API key - no signing, no bearer token.
    See the Authentication guide.
servers:
  - url: https://preuve.ai
security:
  - preuveKey: []
paths:
  /api/agent/agency/reports/{id}:
    get:
      tags:
        - Agency
      summary: Poll a client report
      description: >
        Status, tier, and report URL for one client report in the workspace.
        Does not return the report payload - use the export.
      operationId: getAgencyReport
      parameters:
        - $ref: '#/components/parameters/AgencyReportId'
      responses:
        '200':
          description: Report status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgencyReportStatus'
        '403':
          $ref: '#/components/responses/AgencyInsufficientScope'
        '404':
          description: >
            Unknown report, or it belongs to another workspace (REPORT_NOT_FOUND
            / AGENCY_NOT_FOUND).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    AgencyReportId:
      name: id
      in: path
      required: true
      description: Client report id, scoped to the caller's Agency workspace.
      schema:
        type: string
        format: uuid
  schemas:
    AgencyReportStatus:
      type: object
      properties:
        reportId:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
        scanType:
          type: string
          enum:
            - starter
            - deep
        analysisTier:
          type: string
        readyForExport:
          type: boolean
        reportUrl:
          type: string
          format: uri
        createdAt:
          type: string
          format: date-time
        pollAfterSeconds:
          type: integer
          description: Present only while the report is not terminal.
        reused:
          type: boolean
          description: Present when this clientRunId replayed an existing report.
        dispatchPending:
          type: boolean
          description: >
            The dispatch outcome is unknown. Retry the same clientRunId and
            arguments after 60 seconds; recovery reuses the original report and
            credit. Past 23 hours the recovery text directs you to support
            instead of risking a duplicate job.
        recovery:
          type: string
          description: What to do next, present alongside dispatchPending.
    ApiError:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Human-readable message.
        code:
          type: string
          description: Stable machine-readable code. Branch on this.
        details:
          description: Optional context (validation errors, limits, ...).
  responses:
    AgencyInsufficientScope:
      description: >
        The key is valid but does not carry the one Agency scope the route it
        called requires (INSUFFICIENT_SCOPE). The two are enforced per route and
        neither implies the other: POST /api/agent/agency/analyses requires
        agency:write, and every other Agency route - the workspace context, the
        report list, the report poll and the export - requires agency:read, so
        there is no separate export scope on this surface and a key carrying
        only the other Agency scope is refused here too. Note that every key
        created before 2026-09-09 hits this: these routes previously accepted
        the personal analysis:read / export:read scopes, and scopes are fixed at
        creation rather than backfilled, so an older key needs a new grant.
        Neither route to one is unconditional. Reconnecting the client works on
        any plan, free included, but /authorize only ever intersects the scopes
        the client requests, so a client replaying the scope list it cached at
        registration mints another Agency-less key and revokes the working one
        on the way - check the consent screen lists the Agency permissions
        before approving. Creating a key by hand cannot silently fail, but it
        needs "Include Agency workspace access" ticked AND an account that may
        create keys by hand: a paid personal plan, or membership of a Consultant
        or Agency workspace with an active subscription.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Rate limited (RATE_LIMITED or DAILY_LIMIT_REACHED).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    preuveKey:
      type: apiKey
      in: header
      name: x-preuve-key
      description: >
        Your API key (prv_...), sent as-is. It is the only credential the API
        needs - see the Authentication guide.

````