Suggest extraction fields for a new campaign
curl --request POST \
--url https://api.pineyard.ai/campaigns/suggest-extraction-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agentId: '<string>'})
};
fetch('https://api.pineyard.ai/campaigns/suggest-extraction-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pineyard.ai/campaigns/suggest-extraction-keys"
payload = { "agentId": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"keys": [
{
"name": "<string>",
"type": "string",
"description": "<string>"
}
]
}AI assist
Suggest extraction fields for a new campaign
Propose extraction fields for a not-yet-created campaign, from its agent (AI).
POST
/
campaigns
/
suggest-extraction-keys
Suggest extraction fields for a new campaign
curl --request POST \
--url https://api.pineyard.ai/campaigns/suggest-extraction-keys \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agentId: '<string>'})
};
fetch('https://api.pineyard.ai/campaigns/suggest-extraction-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pineyard.ai/campaigns/suggest-extraction-keys"
payload = { "agentId": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"keys": [
{
"name": "<string>",
"type": "string",
"description": "<string>"
}
]
}Required scope:
campaigns.editAuthorizations
Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.
Body
application/json
Response
Suggested keys
Show child attributes
Show child attributes

