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

# List agent runs

> Runs of one agent, newest first: `improve` (Context7 Agent, default), `review` (PR Review Agent) or `watch` (Code Watch Agent). Any member. Only for GitHub sites: a CLI site (`source: "local"`) answers 404.



## OpenAPI

````yaml https://context7.com/openapi.json get /v2/teamspaces/{teamspaceId}/sites/{siteId}/agent-runs
openapi: 3.0.0
info:
  title: Context7 Public API
  description: >-
    The Context7 Public API provides programmatic access to library
    documentation and search functionality. Get up-to-date documentation and
    code examples for any library.
  version: 2.0.0
  contact:
    name: Context7 Support
    url: https://context7.com
    email: support@context7.com
servers:
  - url: https://context7.com/api
    description: Production server
security: []
tags:
  - name: Search
    description: Search for libraries in the Context7 database
  - name: Context
    description: Retrieve documentation context for queries
  - name: Ask
    description: Answer questions from a website registered with Context7 Ask
  - name: Refresh
    description: Refresh existing libraries to fetch latest documentation
  - name: Policies
    description: Manage teamspace access policies and filters
  - name: Add Library
    description: Submit new libraries for documentation processing
  - name: Metrics
    description: Retrieve usage metrics for libraries
  - name: Usage
    description: See member and teamspace API usage
  - name: Teamspaces
    description: >-
      Teamspaces the caller is a member of. The management API
      (`/v2/teamspaces/*`) accepts a Context7 API key, which reaches only its
      own teamspace and can make changes or read personal data only when it was
      created with write access (other keys can only read and get 403
      `write_access_required` on writes and on personal data), or an OAuth token
      issued for the Context7 Admin MCP server
      (`https://admin.mcp.context7.com/mcp`), which reaches every teamspace of
      the user. A browser session is not accepted.
  - name: Teamspace Admin
    description: >-
      Members, invitations, rules, library policies and requests, usage and the
      spending limit of a teamspace. Every API key can read rules, policies,
      usage and the spending limit. Changes, and reading members, invitations,
      the invite link and library requests (they name people), need an API key
      created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
  - name: Teamspace Libraries
    description: >-
      A teamspace's libraries: its private sources and the libraries it has
      claimed. Add, refresh, configure, version, claim and remove them, and read
      their parse state and usage. A library id `/owner/repo` is two path
      segments. Every API key can read. Changes need an API key created with
      **Write access** ticked (other keys get 403 `write_access_required`), or
      the Context7 Admin MCP sign-in.
  - name: Docs7 Sites
    description: >-
      Docs7 documentation sites of a teamspace: settings, custom domains,
      deployments, previews and the Docs7 agents. Any member can read; owners
      and admins can change; developers can add a site, publish one added for
      the agents only, and rebuild. Sites deployed with the `docs7 deploy` CLI
      have `source: "local"`; operations marked GitHub-only answer 404 for them.
      Every API key can read, except feature requests and the GitHub account
      behind a build (personal data). Changes, and those reads, need an API key
      created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
  - name: Docs7 Analytics
    description: >-
      Traffic of one Docs7 site: visitors, AI crawlers, searches, assistant
      questions and page feedback. Docs7 Free reads the last 7 days, Docs7 Pro
      the last 90. Every API key can read the visitor, crawler and path reports.
      Searches, questions, conversations, feedback and the raw records
      (`explore`) are personal data and need an API key created with **Write
      access** ticked, or the Context7 Admin MCP sign-in.
  - name: Ask Sites
    description: >-
      Manage a teamspace's Context7 Ask sites: add, verify, remove, and read
      their analytics and question log. Every API key can read the sites.
      Changes, and reading the analytics and question log (visitor questions),
      need an API key created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
paths:
  /v2/teamspaces/{teamspaceId}/sites/{siteId}/agent-runs:
    get:
      tags:
        - Docs7 Sites
      summary: List agent runs
      description: >-
        Runs of one agent, newest first: `improve` (Context7 Agent, default),
        `review` (PR Review Agent) or `watch` (Code Watch Agent). Any member.
        Only for GitHub sites: a CLI site (`source: "local"`) answers 404.
      operationId: listDocsAgentRuns
      parameters:
        - name: teamspaceId
          in: path
          required: true
          description: Teamspace id.
          schema:
            type: string
            format: uuid
        - name: siteId
          in: path
          required: true
          description: Docs7 site id.
          schema:
            type: string
            format: uuid
        - name: history
          in: query
          required: false
          description: >-
            Which agent. `snippets` returns the Example Check Agent's batch
            runs; one check is many batches.
          schema:
            type: string
            enum:
              - improve
              - review
              - watch
              - snippets
            default: improve
        - name: limit
          in: query
          required: false
          description: >-
            How many of the newest runs to return. The history keeps the newest
            500 runs of each agent.
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
      responses:
        '200':
          description: The runs
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Docs7AgentRun'
        '400':
          description: Invalid `history` or `limit`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: invalid_history
        '401':
          description: Missing or invalid bearer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: unauthorized
                message: Authentication required.
        '403':
          description: Not a member, missing role, or an API key of another teamspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: forbidden
                message: You do not have permission to do this.
        '404':
          description: No such site in this teamspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: not_found
                message: Site not found.
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Docs7Error'
              example:
                error: internal_error
                message: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    Docs7AgentRun:
      type: object
      required:
        - id
        - siteId
        - number
        - state
        - trigger
        - input
        - pullRequest
        - createdAt
        - completedAt
      properties:
        id:
          type: string
          format: uuid
        siteId:
          type: string
          format: uuid
        number:
          type: integer
          minimum: 1
        boxId:
          type: string
        baseBranch:
          type: string
        baseCommitSha:
          type: string
        state:
          type: string
          enum:
            - running
            - completed
            - failed
            - superseded
        trigger:
          type: string
          enum:
            - schedule
            - manual
            - pull_request
        triggeredBy:
          type: string
          nullable: true
        input:
          type: object
          required:
            - kind
          properties:
            kind:
              type: string
              enum:
                - suggestions
                - health
                - feature_requests
                - page_feedback
                - migrate
                - review
                - code_change
                - snippets
          description: What the run worked on. The other fields depend on `kind`.
        pullRequest:
          type: object
          required:
            - url
            - state
          properties:
            url:
              type: string
              format: uri
            state:
              type: string
              enum:
                - open
                - closed
                - merged
                - unknown
          nullable: true
        review:
          type: object
          properties:
            findings:
              type: array
              items:
                type: object
                properties:
                  check:
                    type: string
                    enum:
                      - brokenLinks
                      - grammar
                      - health
                      - standards
                  file:
                    type: string
                    nullable: true
                  line:
                    type: integer
                    nullable: true
                  message:
                    type: string
                  fixed:
                    type: boolean
            commentUrl:
              type: string
              format: uri
              nullable: true
            commitSha:
              type: string
              nullable: true
          description: PR Review Agent result.
          nullable: true
        snippets:
          type: object
          nullable: true
          description: >-
            Example Check Agent batches: the pages the batch checked and each
            code example's result. Null for other agents and while the batch
            runs.
          properties:
            pages:
              type: array
              items:
                type: string
            last:
              type: boolean
              description: 'No page is left after these: the batch ended its check.'
            blocks:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  file:
                    type: string
                  line:
                    type: integer
                  language:
                    type: string
                    enum:
                      - typescript
                      - javascript
                      - python
                  status:
                    type: string
                    enum:
                      - pass
                      - fail
                      - skipped
                  detail:
                    type: string
                  fixed:
                    type: boolean
                  removed:
                    type: boolean
                    description: >-
                      Taken off the page until the released SDK or the service
                      supports what the page documents.
                  needs:
                    type: array
                    items:
                      type: string
                    description: >-
                      For an example skipped because a service has no variable:
                      the environment variables it reads.
        cost:
          type: object
          properties:
            inputTokens:
              type: number
            outputTokens:
              type: number
            cachedInputTokens:
              type: number
            tokenUsd:
              type: number
            computeUsd:
              type: number
              nullable: true
            durationMs:
              type: number
          nullable: true
        summary:
          type: string
          description: The agent's final message.
          nullable: true
        error:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
          nullable: true
    Docs7Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error code (snake_case).
        message:
          type: string
          description: Human-readable message. Most errors have one.
        details:
          type: object
          description: Validation details on `invalid_payload`.
      description: Docs7 error response
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Get your API key at
        [context7.com/dashboard](https://context7.com/dashboard). Treat your API
        key like a password and store it securely. Every key can read the
        management API (`/v2/teamspaces/*`), except personal data: member and
        invitation emails, library requesters, visitor questions, Docs7 reader
        searches, conversations, feedback and feature requests, and the GitHub
        account behind a build. To read those or make changes there, the key
        must be created with **Write access** ticked; other keys get 403
        `write_access_required`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.