---
title: "Evaluate prompt"
method: POST
path: "/ai/prompts/evaluate"
tags: ["AI - Prompts"]
---

# Evaluate prompt

`POST /ai/prompts/evaluate`

Evaluate an AI prompt

## Request body

- object — Request body schema.
  - `prompt` string, required — Prompt to evaluate.
  - `actions` union[], required — Actions available for evaluation.
    - union
      - object
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `isBulkAllowed` boolean, required
        - `config` object, required
        - `kind` 'tool', required
        - `toolUuid` string, nullable, required
        - `templateSlug` string, nullable, required
        - `waitUntilFinished` boolean, required
      - object
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `isBulkAllowed` boolean, required
        - `config` object, required
        - `kind` 'agent', required
        - `agentUuid` string, nullable, required
        - `templateSlug` string, nullable, required
        - `waitUntilFinished` boolean, required
      - object
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `isBulkAllowed` boolean, required
        - `config` object, required
        - `kind` 'connector', required
        - `integrationSlug` string, required
        - `connectorUuid` string, nullable, required
        - `actionSlug` string, required
  - `resources` union[], required — Resources available for evaluation.
    - union
      - object
        - `kind` 'model', required
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `integrationSlug` string, nullable, required
        - `modelUuid` string, nullable, required
        - `filter` object, nullable, required
          - `conjonction` 'or' | 'and', required
          - `groups` unknown[], required
            - unknown
        - `selectedColumnSlugs` string[], nullable, required
        - `limit` number, nullable, required
        - `prompt` string, nullable, required
        - `isReadOnly` boolean, required
      - object
        - `kind` 'file', required
        - `name` string, nullable, required
        - `slug` string, required
        - `description` string, nullable, required
        - `items` union[], required
          - union
            - object
              - …
            - object
              - …
        - `prompt` string, nullable, required
  - `capabilities` union[], required — Capabilities available for evaluation.
    - union
      - object
        - `slug` 'sandbox', required
        - `config` object, required
          - `scope` 'chat' | 'agent'
      - object
        - `slug` 'context', required
        - `config` object, required
          - `isReadOnly` boolean
      - object
        - `slug` 'app', required
        - `config` object, required
          - `appUuid` string
          - `canPromote` boolean
      - object
        - `slug` 'document', required
        - `config` object, required
      - object
        - `slug` 'webSearch', required
        - `config` object, required
      - object
        - `slug` 'fileSearch', required
        - `config` object, required
      - object
        - `slug` 'documentationSearch', required
        - `config` object, required
      - object
        - `slug` 'codeInterpreter', required
        - `config` object, required
      - object
        - `slug` 'memory', required
        - `config` object, required
      - object
        - `slug` 'suggestedActions', required
        - `config` object, required

## Response `200`

Successful response

- object
  - `prompt` string, required — Evaluated prompt.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/getcargo/apis/cargo-api.md) · [All operations](https://skmtc.net/getcargo/apis/cargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getcargo/cargo-api/revisions/1d5a19e01d83/schema)