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

# Create Suite

> Required scope `agent_eval:create`. Suites are containers — add cases by setting their `suite_id`.

Suites are containers — create the suite first, then add cases by setting their `suite_id`. A suite with no cases can be created but `POST /agent-eval/suites/{id}/run` returns 400 until at least one case is attached.

## Parallelism

`parallelism` (1-16) is the max number of cases that run concurrently when you trigger the suite. Higher = faster sweeps; lower = nicer to your credit balance if you're worried about a pricing surprise.

For a regression suite of \~20 cases, `parallelism: 4` is a good starting point — finishes in roughly the time of the slowest 5 cases.


## OpenAPI

````yaml POST /agent-eval/suites
openapi: 3.1.0
info:
  title: Yappr API
  description: >
    Create and manage AI voice agents, purchase phone numbers, configure tools,
    and initiate calls — all via REST.
  version: 1.0.0
  contact:
    url: https://goyappr.com
servers:
  - url: https://api.goyappr.com
    description: Production
security:
  - apiKey: []
paths:
  /agent-eval/suites:
    post:
      tags:
        - Agent Eval
      summary: Create suite
      description: >-
        Required scope `agent_eval:create`. Suites are containers — add cases by
        setting their `suite_id`.
      operationId: createSuite
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                description:
                  type: string
                agent_id:
                  type: string
                  format: uuid
                  nullable: true
                parallelism:
                  type: integer
                  minimum: 1
                  maximum: 16
                  default: 1
      responses:
        '201':
          description: Suite created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvalSuite'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    EvalSuite:
      type: object
      description: Curated bundle of eval cases that run as one batch (regression sweep).
      required:
        - id
        - company_id
        - name
        - parallelism
        - created_at
      properties:
        id:
          type: string
          format: uuid
        company_id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
          nullable: true
        agent_id:
          type: string
          format: uuid
          nullable: true
          description: >
            Optional default agent for ad-hoc cases added to the suite. Per-case
            `agent_id` always wins; this is just a convenience for the
            dashboard.
        parallelism:
          type: integer
          minimum: 1
          maximum: 16
          default: 1
          description: Max concurrent cases when the suite runs.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        deleted_at:
          type: string
          format: date-time
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Your Yappr API key (e.g. `ypr_live_...`). Generate one in the dashboard
        under **Settings → API Keys**.

````