Create a play
curl --request POST \
--url https://api.retriever.run/v1/plays \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"signal": "<string>",
"segment": "<string>",
"whoToTarget": "<string>",
"why": "<string>",
"context": [
"<string>"
],
"delivery": {
"cadence": {
"everyDays": 15,
"time": "07:00"
},
"notify": {
"email": true,
"slack": true,
"crm": true
}
},
"limits": {
"targetQualifiedLeadsPerRun": 50,
"maxCreditsPerRun": 500
}
}
'import requests
url = "https://api.retriever.run/v1/plays"
payload = {
"name": "<string>",
"signal": "<string>",
"segment": "<string>",
"whoToTarget": "<string>",
"why": "<string>",
"context": ["<string>"],
"delivery": {
"cadence": {
"everyDays": 15,
"time": "07:00"
},
"notify": {
"email": True,
"slack": True,
"crm": True
}
},
"limits": {
"targetQualifiedLeadsPerRun": 50,
"maxCreditsPerRun": 500
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
signal: '<string>',
segment: '<string>',
whoToTarget: '<string>',
why: '<string>',
context: ['<string>'],
delivery: {
cadence: {everyDays: 15, time: '07:00'},
notify: {email: true, slack: true, crm: true}
},
limits: {targetQualifiedLeadsPerRun: 50, maxCreditsPerRun: 500}
})
};
fetch('https://api.retriever.run/v1/plays', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.retriever.run/v1/plays",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'signal' => '<string>',
'segment' => '<string>',
'whoToTarget' => '<string>',
'why' => '<string>',
'context' => [
'<string>'
],
'delivery' => [
'cadence' => [
'everyDays' => 15,
'time' => '07:00'
],
'notify' => [
'email' => true,
'slack' => true,
'crm' => true
]
],
'limits' => [
'targetQualifiedLeadsPerRun' => 50,
'maxCreditsPerRun' => 500
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.retriever.run/v1/plays"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"signal\": \"<string>\",\n \"segment\": \"<string>\",\n \"whoToTarget\": \"<string>\",\n \"why\": \"<string>\",\n \"context\": [\n \"<string>\"\n ],\n \"delivery\": {\n \"cadence\": {\n \"everyDays\": 15,\n \"time\": \"07:00\"\n },\n \"notify\": {\n \"email\": true,\n \"slack\": true,\n \"crm\": true\n }\n },\n \"limits\": {\n \"targetQualifiedLeadsPerRun\": 50,\n \"maxCreditsPerRun\": 500\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.retriever.run/v1/plays")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"signal\": \"<string>\",\n \"segment\": \"<string>\",\n \"whoToTarget\": \"<string>\",\n \"why\": \"<string>\",\n \"context\": [\n \"<string>\"\n ],\n \"delivery\": {\n \"cadence\": {\n \"everyDays\": 15,\n \"time\": \"07:00\"\n },\n \"notify\": {\n \"email\": true,\n \"slack\": true,\n \"crm\": true\n }\n },\n \"limits\": {\n \"targetQualifiedLeadsPerRun\": 50,\n \"maxCreditsPerRun\": 500\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.retriever.run/v1/plays")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"signal\": \"<string>\",\n \"segment\": \"<string>\",\n \"whoToTarget\": \"<string>\",\n \"why\": \"<string>\",\n \"context\": [\n \"<string>\"\n ],\n \"delivery\": {\n \"cadence\": {\n \"everyDays\": 15,\n \"time\": \"07:00\"\n },\n \"notify\": {\n \"email\": true,\n \"slack\": true,\n \"crm\": true\n }\n },\n \"limits\": {\n \"targetQualifiedLeadsPerRun\": 50,\n \"maxCreditsPerRun\": 500\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"status": "draft",
"origin": "onboarding",
"launched": true,
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"links": {
"self": "<string>",
"leads": "<string>",
"app": "<string>"
},
"workspace_id": "<string>",
"schedule_id": "<string>",
"config": {},
"limits": {
"targetQualifiedLeadsPerRun": 123,
"maxCreditsPerRun": 123
},
"leads": {
"to_review": 123,
"accepted": 123,
"rejected": 123,
"in_sequence": 123
},
"left_aside": 123,
"missing_accounts": [
"email"
]
}{
"error": {
"code": "invalid_request",
"message": "prompt: prompt must not be blank",
"details": [
{
"path": "prompt",
"message": "prompt must not be blank"
}
]
}
}{
"error": {
"code": "not_authenticated",
"message": "A valid API key is required."
}
}{
"error": {
"code": "invalid_request",
"message": "Content-Type must be application/json."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Retry in 12 s."
}
}Plays
Create a play
Creates a draft: it runs nothing. The body is the plays contract the app’s agent uses. defaulted names the parts left to their default.
POST
/
v1
/
plays
Create a play
curl --request POST \
--url https://api.retriever.run/v1/plays \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"signal": "<string>",
"segment": "<string>",
"whoToTarget": "<string>",
"why": "<string>",
"context": [
"<string>"
],
"delivery": {
"cadence": {
"everyDays": 15,
"time": "07:00"
},
"notify": {
"email": true,
"slack": true,
"crm": true
}
},
"limits": {
"targetQualifiedLeadsPerRun": 50,
"maxCreditsPerRun": 500
}
}
'import requests
url = "https://api.retriever.run/v1/plays"
payload = {
"name": "<string>",
"signal": "<string>",
"segment": "<string>",
"whoToTarget": "<string>",
"why": "<string>",
"context": ["<string>"],
"delivery": {
"cadence": {
"everyDays": 15,
"time": "07:00"
},
"notify": {
"email": True,
"slack": True,
"crm": True
}
},
"limits": {
"targetQualifiedLeadsPerRun": 50,
"maxCreditsPerRun": 500
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
signal: '<string>',
segment: '<string>',
whoToTarget: '<string>',
why: '<string>',
context: ['<string>'],
delivery: {
cadence: {everyDays: 15, time: '07:00'},
notify: {email: true, slack: true, crm: true}
},
limits: {targetQualifiedLeadsPerRun: 50, maxCreditsPerRun: 500}
})
};
fetch('https://api.retriever.run/v1/plays', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.retriever.run/v1/plays",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'signal' => '<string>',
'segment' => '<string>',
'whoToTarget' => '<string>',
'why' => '<string>',
'context' => [
'<string>'
],
'delivery' => [
'cadence' => [
'everyDays' => 15,
'time' => '07:00'
],
'notify' => [
'email' => true,
'slack' => true,
'crm' => true
]
],
'limits' => [
'targetQualifiedLeadsPerRun' => 50,
'maxCreditsPerRun' => 500
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.retriever.run/v1/plays"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"signal\": \"<string>\",\n \"segment\": \"<string>\",\n \"whoToTarget\": \"<string>\",\n \"why\": \"<string>\",\n \"context\": [\n \"<string>\"\n ],\n \"delivery\": {\n \"cadence\": {\n \"everyDays\": 15,\n \"time\": \"07:00\"\n },\n \"notify\": {\n \"email\": true,\n \"slack\": true,\n \"crm\": true\n }\n },\n \"limits\": {\n \"targetQualifiedLeadsPerRun\": 50,\n \"maxCreditsPerRun\": 500\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.retriever.run/v1/plays")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"signal\": \"<string>\",\n \"segment\": \"<string>\",\n \"whoToTarget\": \"<string>\",\n \"why\": \"<string>\",\n \"context\": [\n \"<string>\"\n ],\n \"delivery\": {\n \"cadence\": {\n \"everyDays\": 15,\n \"time\": \"07:00\"\n },\n \"notify\": {\n \"email\": true,\n \"slack\": true,\n \"crm\": true\n }\n },\n \"limits\": {\n \"targetQualifiedLeadsPerRun\": 50,\n \"maxCreditsPerRun\": 500\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.retriever.run/v1/plays")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"signal\": \"<string>\",\n \"segment\": \"<string>\",\n \"whoToTarget\": \"<string>\",\n \"why\": \"<string>\",\n \"context\": [\n \"<string>\"\n ],\n \"delivery\": {\n \"cadence\": {\n \"everyDays\": 15,\n \"time\": \"07:00\"\n },\n \"notify\": {\n \"email\": true,\n \"slack\": true,\n \"crm\": true\n }\n },\n \"limits\": {\n \"targetQualifiedLeadsPerRun\": 50,\n \"maxCreditsPerRun\": 500\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"status": "draft",
"origin": "onboarding",
"launched": true,
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"links": {
"self": "<string>",
"leads": "<string>",
"app": "<string>"
},
"workspace_id": "<string>",
"schedule_id": "<string>",
"config": {},
"limits": {
"targetQualifiedLeadsPerRun": 123,
"maxCreditsPerRun": 123
},
"leads": {
"to_review": 123,
"accepted": 123,
"rejected": 123,
"in_sequence": 123
},
"left_aside": 123,
"missing_accounts": [
"email"
]
}{
"error": {
"code": "invalid_request",
"message": "prompt: prompt must not be blank",
"details": [
{
"path": "prompt",
"message": "prompt must not be blank"
}
]
}
}{
"error": {
"code": "not_authenticated",
"message": "A valid API key is required."
}
}{
"error": {
"code": "invalid_request",
"message": "Content-Type must be application/json."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded. Retry in 12 s."
}
}Body
application/json
The plays contract (playDraftSchema in app-core). Each field left out takes its default: review before sending, a run every day at 07:00, 10 leads per run, the channel's usual steps.
Response
The draft, with defaulted.