Replace the agent setup draft
curl --request PUT \
--url https://devtune.ai/api/v2/agent/setup-draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"trial_plan": "<string>",
"visibility": {
"domain": "<string>",
"brand_context": "<string>",
"competitors": [
{
"name": "<string>",
"urls": [
"<string>"
]
}
],
"prompts": [
"<string>"
]
},
"agent_picks": {
"starting_point": "use_category",
"setup": {}
}
}
'import requests
url = "https://devtune.ai/api/v2/agent/setup-draft"
payload = {
"trial_plan": "<string>",
"visibility": {
"domain": "<string>",
"brand_context": "<string>",
"competitors": [
{
"name": "<string>",
"urls": ["<string>"]
}
],
"prompts": ["<string>"]
},
"agent_picks": {
"starting_point": "use_category",
"setup": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
trial_plan: '<string>',
visibility: {
domain: '<string>',
brand_context: '<string>',
competitors: [{name: '<string>', urls: ['<string>']}],
prompts: ['<string>']
},
agent_picks: {starting_point: 'use_category', setup: {}}
})
};
fetch('https://devtune.ai/api/v2/agent/setup-draft', 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://devtune.ai/api/v2/agent/setup-draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'trial_plan' => '<string>',
'visibility' => [
'domain' => '<string>',
'brand_context' => '<string>',
'competitors' => [
[
'name' => '<string>',
'urls' => [
'<string>'
]
]
],
'prompts' => [
'<string>'
]
],
'agent_picks' => [
'starting_point' => 'use_category',
'setup' => [
]
]
]),
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://devtune.ai/api/v2/agent/setup-draft"
payload := strings.NewReader("{\n \"trial_plan\": \"<string>\",\n \"visibility\": {\n \"domain\": \"<string>\",\n \"brand_context\": \"<string>\",\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ]\n }\n ],\n \"prompts\": [\n \"<string>\"\n ]\n },\n \"agent_picks\": {\n \"starting_point\": \"use_category\",\n \"setup\": {}\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://devtune.ai/api/v2/agent/setup-draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"trial_plan\": \"<string>\",\n \"visibility\": {\n \"domain\": \"<string>\",\n \"brand_context\": \"<string>\",\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ]\n }\n ],\n \"prompts\": [\n \"<string>\"\n ]\n },\n \"agent_picks\": {\n \"starting_point\": \"use_category\",\n \"setup\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://devtune.ai/api/v2/agent/setup-draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"trial_plan\": \"<string>\",\n \"visibility\": {\n \"domain\": \"<string>\",\n \"brand_context\": \"<string>\",\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ]\n }\n ],\n \"prompts\": [\n \"<string>\"\n ]\n },\n \"agent_picks\": {\n \"starting_point\": \"use_category\",\n \"setup\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"draft": {
"product": "ai-search",
"trial_plan": "<string>",
"visibility": {
"domain": "<string>",
"brand_context": "<string>",
"competitors": [
{
"name": "<string>",
"urls": [
"<string>"
]
}
],
"prompts": [
"<string>"
]
},
"agent_picks": {
"starting_point": "use_category",
"setup": {}
}
},
"updated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}Agent registration
Replace the agent setup draft
Replaces the draft whole. It validates as the post-claim API would: the Agent Picks setup and job as saveAgentPicksSetup and saveAgentPicksJob accept them, with ids in the published catalogue. A refused draft is 400 invalid_draft naming the first problem. Takes an agent access token, not an API key. Requires the setup.draft scope.
PUT
/
agent
/
setup-draft
Replace the agent setup draft
curl --request PUT \
--url https://devtune.ai/api/v2/agent/setup-draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"trial_plan": "<string>",
"visibility": {
"domain": "<string>",
"brand_context": "<string>",
"competitors": [
{
"name": "<string>",
"urls": [
"<string>"
]
}
],
"prompts": [
"<string>"
]
},
"agent_picks": {
"starting_point": "use_category",
"setup": {}
}
}
'import requests
url = "https://devtune.ai/api/v2/agent/setup-draft"
payload = {
"trial_plan": "<string>",
"visibility": {
"domain": "<string>",
"brand_context": "<string>",
"competitors": [
{
"name": "<string>",
"urls": ["<string>"]
}
],
"prompts": ["<string>"]
},
"agent_picks": {
"starting_point": "use_category",
"setup": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
trial_plan: '<string>',
visibility: {
domain: '<string>',
brand_context: '<string>',
competitors: [{name: '<string>', urls: ['<string>']}],
prompts: ['<string>']
},
agent_picks: {starting_point: 'use_category', setup: {}}
})
};
fetch('https://devtune.ai/api/v2/agent/setup-draft', 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://devtune.ai/api/v2/agent/setup-draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'trial_plan' => '<string>',
'visibility' => [
'domain' => '<string>',
'brand_context' => '<string>',
'competitors' => [
[
'name' => '<string>',
'urls' => [
'<string>'
]
]
],
'prompts' => [
'<string>'
]
],
'agent_picks' => [
'starting_point' => 'use_category',
'setup' => [
]
]
]),
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://devtune.ai/api/v2/agent/setup-draft"
payload := strings.NewReader("{\n \"trial_plan\": \"<string>\",\n \"visibility\": {\n \"domain\": \"<string>\",\n \"brand_context\": \"<string>\",\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ]\n }\n ],\n \"prompts\": [\n \"<string>\"\n ]\n },\n \"agent_picks\": {\n \"starting_point\": \"use_category\",\n \"setup\": {}\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://devtune.ai/api/v2/agent/setup-draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"trial_plan\": \"<string>\",\n \"visibility\": {\n \"domain\": \"<string>\",\n \"brand_context\": \"<string>\",\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ]\n }\n ],\n \"prompts\": [\n \"<string>\"\n ]\n },\n \"agent_picks\": {\n \"starting_point\": \"use_category\",\n \"setup\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://devtune.ai/api/v2/agent/setup-draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"trial_plan\": \"<string>\",\n \"visibility\": {\n \"domain\": \"<string>\",\n \"brand_context\": \"<string>\",\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ]\n }\n ],\n \"prompts\": [\n \"<string>\"\n ]\n },\n \"agent_picks\": {\n \"starting_point\": \"use_category\",\n \"setup\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"draft": {
"product": "ai-search",
"trial_plan": "<string>",
"visibility": {
"domain": "<string>",
"brand_context": "<string>",
"competitors": [
{
"name": "<string>",
"urls": [
"<string>"
]
}
],
"prompts": [
"<string>"
]
},
"agent_picks": {
"starting_point": "use_category",
"setup": {}
}
},
"updated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"status": 123,
"reason": "<string>",
"details": {}
}Authorizations
Access token from an unclaimed agent registration (dtk_agent_ prefix), holding only setup.draft. Register at /agent/identity and exchange the identity assertion at /oauth2/token, as /auth.md describes. Only operations listing agentBearer accept it. Once a person claims the registration, its tokens act as the claimed API key under bearerAuth instead.
Body
application/json
An unclaimed agent registration’s project setup, replaced whole. visibility is required for ai-search and both and refused otherwise; agent_picks is required for agent-picks and both and refused otherwise. Probed platforms are not part of a draft. Plan limits are applied when a person claims the registration.
What the project is set up for: ai-search, agent-picks or both.
Available options:
ai-search, agent-picks, both The Agent Picks plan a new account’s trial starts on: plus, pro or a price id. Only for agent-picks and both. Null when none is chosen.
The AI search setup. Null unless product is ai-search or both.
Show child attributes
Show child attributes
The Agent Picks setup: a public category's setup (use_category) or the project's own job (start_from_scratch). Null unless product is agent-picks or both.
- Option 1
- Option 2
Show child attributes
Show child attributes