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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# List the project's run plans

> List the project's run plans. Archived plans are left out unless includeArchived is set. Test suites are not run plans and are listed by the test suites family.



## OpenAPI

````yaml GET /api/v1/run-plans
openapi: 3.1.0
info:
  title: LangWatch API
  version: 1.0.0
  description: LangWatch openapi spec
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/run-plans:
    get:
      tags:
        - Run Plans
      description: >-
        List the project's run plans. Archived plans are left out unless
        includeArchived is set. Test suites are not run plans and are listed by
        the test suites family.
      operationId: listRunPlans
      parameters:
        - in: query
          name: includeArchived
          schema:
            type: string
            default: 'false'
          description: >-
            Include archived run plans in the list. true, 1, yes for yes; false,
            0, no or omitted for no.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The run plan id.
                    name:
                      type: string
                      description: >-
                        The run plan name. This is the plan's identity: a run
                        started under this name joins this plan.
                    slug:
                      type: string
                      description: >-
                        The plan's address in the platform. It is kept when the
                        plan is renamed, so run history never moves.
                    scope:
                      oneOf:
                        - type: object
                          properties:
                            mode:
                              type: string
                              const: all
                          required:
                            - mode
                        - type: object
                          properties:
                            mode:
                              type: string
                              const: folders
                            folderIds:
                              type: array
                              items:
                                type: string
                          required:
                            - mode
                            - folderIds
                        - type: object
                          properties:
                            mode:
                              type: string
                              const: labels
                            labels:
                              type: array
                              items:
                                type: string
                          required:
                            - mode
                            - labels
                        - type: object
                          properties:
                            mode:
                              type: string
                              const: cases
                          required:
                            - mode
                      description: >-
                        What the run plan covers: all (every active scenario),
                        folders (the scenarios filed in the named test suites),
                        labels (the scenarios carrying any of the labels), or
                        cases (the scenarioIds sent with the configuration). A
                        dynamic scope is resolved again at every run, so a
                        scenario written later runs without editing the plan.
                    scenarioIds:
                      type: array
                      items:
                        type: string
                      description: The scenarios the last run of this plan covered.
                    targets:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - prompt
                              - http
                              - code
                              - workflow
                            description: What kind of thing the scenarios run against.
                          referenceId:
                            type: string
                            description: >-
                              The id of the prompt, agent or workflow to run
                              against.
                        required:
                          - type
                          - referenceId
                      description: >-
                        What the plan runs against, in the order the results
                        show.
                    repeatCount:
                      type: number
                      description: How many times each scenario and target pairing runs.
                    simulatorModel:
                      type:
                        - string
                        - 'null'
                      description: >-
                        The model that plays the user, or null for the scenario
                        or project default.
                    judgeModel:
                      type:
                        - string
                        - 'null'
                      description: >-
                        The model that judges the run, or null for the scenario
                        or project default.
                    labels:
                      type: array
                      items:
                        type: string
                      description: The labels the plan carries.
                    archivedAt:
                      type:
                        - string
                        - 'null'
                      description: When the plan was archived, or null while it is active.
                    createdAt:
                      type: string
                      description: When the plan was created.
                    updatedAt:
                      type: string
                      description: When the plan was last written.
                    platformUrl:
                      type: string
                      format: uri
                      description: Where to open this run plan in the LangWatch platform.
                  required:
                    - id
                    - name
                    - slug
                    - scope
                    - scenarioIds
                    - targets
                    - repeatCount
                    - simulatorModel
                    - judgeModel
                    - labels
                    - archivedAt
                    - createdAt
                    - updatedAt
                    - platformUrl
      security:
        - project_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````