Suggest evaluation metrics for a new campaign

Propose extra evaluation metrics for a not-yet-created campaign, from its agent (AI).

POST /campaigns/suggest-evaluation-metrics

Suggest evaluation metrics for a new campaign

cURL

curl --request POST \
  --url https://api.pineyard.ai/campaigns/suggest-evaluation-metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>"
}
'

200

{
  "metrics": [
    {
      "key": "<string>",
      "label": "<string>",
      "allowedValues": [
        "<string>"
      ],
      "prompt": "<string>",
      "builtin": true
    }
  ]
}

Required scope: campaigns.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

agentId · string · required

campaignName · string

campaignDescription · string

Maximum string length: 4000

campaignTypeId · string

instructions · string

Maximum string length: 8000

Response

200

application/json

Suggested metrics

metrics · object[] · required

Maximum array length: 12

Show child attributes