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

# Suggest an evaluation-metric prompt

> Generate or rewrite a single evaluation-metric classification prompt (AI).

**Required scope:** `campaigns.edit`


## OpenAPI

````yaml /api-reference/openapi.json post /campaigns/suggest-metric-prompt
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /campaigns/suggest-metric-prompt:
    post:
      summary: Suggest an evaluation-metric prompt
      description: >-
        Generate or rewrite a single evaluation-metric classification prompt
        (AI).
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                mode:
                  type: string
                  enum:
                    - generate
                    - rewrite
                  default: generate
                label:
                  type: string
                  minLength: 1
                  maxLength: 60
                allowedValues:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 2
                  maxItems: 24
                currentPrompt:
                  type: string
                  maxLength: 5000
                agentId:
                  type: string
                campaignName:
                  type: string
              required:
                - label
                - allowedValues
      responses:
        '200':
          description: Prompt
          content:
            application/json:
              schema:
                type: object
                properties:
                  prompt:
                    type: string
                required:
                  - prompt
        '400':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.

            - `invalid_request`: The input was rejected.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '422':
          description: >-
            - `rewrite_too_long`: The AI-generated or rewritten metric prompt
            came out longer than the 5,000-character limit. Try again, or
            shorten the original prompt.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).

            - `suggestion_failed`: AI suggestion generation failed (any error).
        '503':
          description: '- `database_unavailable`: The service is temporarily unavailable.'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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