Suggest an evaluation-metric prompt

curl --request POST \
  --url https://api.pineyard.ai/campaigns/suggest-metric-prompt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "allowedValues": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', allowedValues: ['<string>']})
};

fetch('https://api.pineyard.ai/campaigns/suggest-metric-prompt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pineyard.ai/campaigns/suggest-metric-prompt"

payload = {
    "label": "<string>",
    "allowedValues": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "prompt": "<string>"
}

POST

campaigns

suggest-metric-prompt

Suggest an evaluation-metric prompt

curl --request POST \
  --url https://api.pineyard.ai/campaigns/suggest-metric-prompt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "allowedValues": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', allowedValues: ['<string>']})
};

fetch('https://api.pineyard.ai/campaigns/suggest-metric-prompt', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pineyard.ai/campaigns/suggest-metric-prompt"

payload = {
    "label": "<string>",
    "allowedValues": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "prompt": "<string>"
}

Required scope: campaigns.edit

Authorizations

Authorization

string

header

required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

label

string

required

Required string length: 1 - 60

allowedValues

string[]

required

Required array length: 2 - 24 elements

Minimum string length: 1

mode

enum<string>

default:generate

Available options:

generate,

rewrite

currentPrompt

string

Maximum string length: 5000

agentId

string

campaignName

string

Response

Prompt

prompt

string

required

Overview

Public API (v1)

Agents

Campaigns

Calls & analytics

Phone numbers

WhatsApp

Chatbots & knowledge bases

Integrations & CRM

Speech analysis

Commerce

Workflows

Workspace

Suggest an evaluation-metric prompt

Authorizations

Body

Response