Evaluate prompt

Evaluate an AI prompt

POST /ai/prompts/evaluate

Evaluate prompt

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/ai/prompts/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "actions": [
    {
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "isBulkAllowed": true,
      "config": {},
      "kind": "<string>",
      "toolUuid": "<string>",
      "templateSlug": "<string>"
    }
  ],
  "resources": [
    {
      "kind": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "integrationSlug": "<string>",
      "modelUuid": "<string>",
      "filter": {
        "groups": [
          "<unknown>"
        ]
      },
      "selectedColumnSlugs": [
        "<string>"
      ],
      "limit": 123,
      "prompt": "<string>"
    }
  ],
  "capabilities": [
    {
      "slug": "<string>"
    }
  ]
}
'

200

{
  "prompt": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

prompt · string · required

Prompt to evaluate.

actions · Actions · object[] · required

Actions available for evaluation.

Option 1

Option 2

Option 3

Show child attributes

resources · Resources · object[] · required

Resources available for evaluation.

Option 1

Option 2

Show child attributes

capabilities · Capabilities · object[] · required

Capabilities available for evaluation.

Show child attributes

Response

200

application/json

Successful response

prompt · string · required

Evaluated prompt.