Skip to main content
POST
/
ai
/
prompts
/
evaluate
Evaluate prompt
curl --request POST \
  --url https://api.getcargo.io/v1/ai/prompts/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "tools": [
    {
      "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": {
        "conjonction": "or",
        "groups": [
          "<unknown>"
        ]
      },
      "selectedColumnSlugs": [
        "<string>"
      ],
      "limit": 123,
      "prompt": "<string>"
    }
  ],
  "capabilities": [
    {
      "slug": "<string>"
    }
  ]
}
'
{
  "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.

tools
Tools · object[]
required

Tools available for evaluation.

resources
Resources · object[]
required

Resources available for evaluation.

capabilities
Capabilities · object[]
required

Capabilities available for evaluation.

Response

Successful response

prompt
string
required

Evaluated prompt.