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

# Get a suite and the setup its cases share



## OpenAPI

````yaml /openapi.json post /v1/evals.suites.get
openapi: 3.1.0
info:
  title: Anpord API
  version: 1.0.0
  description: >-
    Run agent evals and manage prompts. Every endpoint takes a JSON body over
    POST and authenticates with a bearer API key.
servers:
  - description: Production
    url: https://api.anpord.com
security: []
tags:
  - name: Connectors
    description: >-
      Connect the credentials an eval run needs: a harness to drive, a sandbox
      to run in, and a model to play a case's human.
  - name: Batches
    description: Runs started together, such as every case of a suite on every variant.
  - name: Suites
    description: >-
      A prompt and workspace shared by many cases. List its cases with
      `evals.cases.list` and its `suite` filter.
  - name: Cases
    description: One eval each, belonging to a suite, run on one or more variants.
  - name: Runs
    description: One case run on one variant, with its trials.
  - name: Models
    description: The models a variant can name.
  - name: Prompts
    description: >-
      Read and write prompts. Content is versioned, so writes append rather than
      overwrite, and channels decide which version callers receive.
paths:
  /v1/evals.suites.get:
    post:
      tags:
        - Suites
      summary: Get a suite and the setup its cases share
      operationId: suites.get
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ById'
        required: true
      responses:
        '200':
          description: A suite, the setup its cases share, and every tag they carry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvalSuiteDetail'
        '400':
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/HttpApiDecodeError'
                  - $ref: '#/components/schemas/BadRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Conflict'
      security:
        - bearer: []
components:
  schemas:
    ById:
      type: object
      required:
        - id
      properties:
        id:
          type: string
      additionalProperties: false
      description: Select one by id.
    EvalSuiteDetail:
      type: object
      required:
        - cases
        - id
        - lastRunAt
        - name
        - tally
        - variants
        - setup
        - tags
      properties:
        cases:
          $ref: '#/components/schemas/Int'
        id:
          $ref: '#/components/schemas/EvalSuiteId'
        lastRunAt:
          anyOf:
            - $ref: '#/components/schemas/EvalTimestamp'
            - type: 'null'
        name:
          type: string
        tally:
          $ref: '#/components/schemas/EvalTally'
        variants:
          $ref: '#/components/schemas/Int'
        setup:
          $ref: '#/components/schemas/EvalSuiteSetup'
        tags:
          type: array
          items:
            type: string
      additionalProperties: false
      description: A suite, the setup its cases share, and every tag they carry.
    HttpApiDecodeError:
      type: object
      required:
        - issues
        - message
        - _tag
      properties:
        issues:
          type: array
          items:
            $ref: '#/components/schemas/Issue'
        message:
          type: string
        _tag:
          type: string
          enum:
            - HttpApiDecodeError
      additionalProperties: false
      description: The request did not match the expected schema
    BadRequest:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - BadRequest
      additionalProperties: false
    Unauthorized:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - Unauthorized
      additionalProperties: false
    Forbidden:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - Forbidden
      additionalProperties: false
    NotFound:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - NotFound
      additionalProperties: false
    Conflict:
      type: object
      required:
        - message
        - _tag
      properties:
        message:
          type: string
        _tag:
          type: string
          enum:
            - Conflict
      additionalProperties: false
    Int:
      type: integer
      description: an integer
      title: int
    EvalSuiteId:
      type: string
      description: The stable handle an author gives a suite.
      title: maxLength(100)
      minLength: 1
      maxLength: 100
      pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
    EvalTimestamp:
      type: string
      description: An ISO-8601 timestamp in UTC.
      format: date-time
    EvalTally:
      type: object
      required:
        - passed
        - scored
      properties:
        passed:
          $ref: '#/components/schemas/Int'
        scored:
          $ref: '#/components/schemas/Int'
      additionalProperties: false
      description: How many trials were scored across a group, and how many passed.
    EvalSuiteSetup:
      type: object
      required:
        - prompt
        - source
      properties:
        prompt:
          anyOf:
            - type: string
            - type: 'null'
        source:
          anyOf:
            - $ref: '#/components/schemas/EvalSource'
            - type: 'null'
      additionalProperties: false
      description: >-
        The prompt and workspace a suite's cases share, before a case overrides
        either. Null where the suite last ran before they were recorded.
    Issue:
      type: object
      required:
        - _tag
        - path
        - message
      properties:
        _tag:
          type: string
          enum:
            - Pointer
            - Unexpected
            - Missing
            - Composite
            - Refinement
            - Transformation
            - Type
            - Forbidden
          description: The tag identifying the type of parse issue
        path:
          type: array
          items:
            $ref: '#/components/schemas/PropertyKey'
          description: The path to the property where the issue occurred
        message:
          type: string
          description: A descriptive message explaining the issue
      additionalProperties: false
      description: >-
        Represents an error encountered while parsing a value to match the
        schema
    EvalSource:
      anyOf:
        - type: object
          required:
            - kind
          properties:
            kind:
              type: string
              enum:
                - empty
          additionalProperties: false
        - type: object
          required:
            - kind
            - ref
            - url
          properties:
            kind:
              type: string
              enum:
                - repo
            ref:
              anyOf:
                - type: string
                - type: 'null'
            url:
              type: string
              description: a string at least 1 character(s) long
              title: minLength(1)
              minLength: 1
          additionalProperties: false
        - type: object
          required:
            - files
            - kind
          properties:
            files:
              type: object
              required: []
              properties: {}
              additionalProperties:
                type: string
            kind:
              type: string
              enum:
                - files
          additionalProperties: false
      description: The workspace available to the harness before setup runs.
    PropertyKey:
      anyOf:
        - type: string
        - type: number
        - type: object
          required:
            - _tag
            - key
          properties:
            _tag:
              type: string
              enum:
                - symbol
            key:
              type: string
          additionalProperties: false
          description: an object to be decoded into a globally shared symbol
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````