Skip to main content
PATCH
/
v1
/
ai
/
eval
/
prompt-sets
/
{promptSetId}
Update an eval prompt set
curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/ai/eval/prompt-sets/{promptSetId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "prompts": [
    {
      "prompt_text": "What are the top 10 products by revenue this quarter?",
      "expectation": "The top product by revenue should be Aniseed Syrup.",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'
{
  "prompt_set": {
    "created_at": "2025-01-15T10:00:00.000Z",
    "description": "Regression suite for the orders topic",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "is_archived": false,
    "model_id": "880e8400-e29b-41d4-a716-446655440003",
    "name": "Orders regression",
    "prompts": [
      {
        "created_at": "2025-01-15T10:00:00.000Z",
        "expectation": "The top product by revenue should be Aniseed Syrup.",
        "id": "770e8400-e29b-41d4-a716-446655440002",
        "prompt_text": "What are the top 5 products by revenue?",
        "updated_at": "2025-01-15T10:00:00.000Z"
      }
    ],
    "slug": "orders-regression",
    "updated_at": "2025-01-15T10:00:00.000Z"
  }
}

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

promptSetId
string<uuid>
required

The unique identifier of the eval prompt set.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
description
string | null

New description for the prompt set. Pass null to clear. Max 1024 characters.

Maximum string length: 1024
name
string

New human-readable name for the prompt set. 255 characters or fewer.

Required string length: 1 - 255
prompts
object[]

Full desired set of prompts after the update. Prompts omitted from this list are deleted; new prompts (no id) are appended in body order. Existing prompts retain their original position — reordering is not supported on this endpoint. At most 25 prompts total.

Maximum array length: 25

Response

Prompt set updated successfully.

prompt_set
object
required