Create user agent
curl --request POST \
--url https://neo.api.projectdiscovery.io/api/v1/agents/user \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "<string>",
"name": "<string>",
"system_context": "<string>",
"custom_tools": [
{
"command_template": "<string>",
"description": "<string>",
"id": "<string>",
"input_schema": {},
"is_executable": true,
"script_content": "<string>",
"script_path": "<string>",
"timeout_seconds": 123
}
],
"description": "<string>",
"install_commands": [
"<string>"
],
"is_dynamic": true,
"native_tools": [
"<string>"
],
"prereq_packages": [
"<string>"
],
"require_env_vars": [
"<string>"
],
"tags": [
"<string>"
],
"verify_commands": [
"<string>"
],
"when_to_use": "<string>"
}
'import requests
url = "https://neo.api.projectdiscovery.io/api/v1/agents/user"
payload = {
"agent_id": "<string>",
"name": "<string>",
"system_context": "<string>",
"custom_tools": [
{
"command_template": "<string>",
"description": "<string>",
"id": "<string>",
"input_schema": {},
"is_executable": True,
"script_content": "<string>",
"script_path": "<string>",
"timeout_seconds": 123
}
],
"description": "<string>",
"install_commands": ["<string>"],
"is_dynamic": True,
"native_tools": ["<string>"],
"prereq_packages": ["<string>"],
"require_env_vars": ["<string>"],
"tags": ["<string>"],
"verify_commands": ["<string>"],
"when_to_use": "<string>"
}
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({
agent_id: '<string>',
name: '<string>',
system_context: '<string>',
custom_tools: [
{
command_template: '<string>',
description: '<string>',
id: '<string>',
input_schema: {},
is_executable: true,
script_content: '<string>',
script_path: '<string>',
timeout_seconds: 123
}
],
description: '<string>',
install_commands: ['<string>'],
is_dynamic: true,
native_tools: ['<string>'],
prereq_packages: ['<string>'],
require_env_vars: ['<string>'],
tags: ['<string>'],
verify_commands: ['<string>'],
when_to_use: '<string>'
})
};
fetch('https://neo.api.projectdiscovery.io/api/v1/agents/user', 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://neo.api.projectdiscovery.io/api/v1/agents/user",
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([
'agent_id' => '<string>',
'name' => '<string>',
'system_context' => '<string>',
'custom_tools' => [
[
'command_template' => '<string>',
'description' => '<string>',
'id' => '<string>',
'input_schema' => [
],
'is_executable' => true,
'script_content' => '<string>',
'script_path' => '<string>',
'timeout_seconds' => 123
]
],
'description' => '<string>',
'install_commands' => [
'<string>'
],
'is_dynamic' => true,
'native_tools' => [
'<string>'
],
'prereq_packages' => [
'<string>'
],
'require_env_vars' => [
'<string>'
],
'tags' => [
'<string>'
],
'verify_commands' => [
'<string>'
],
'when_to_use' => '<string>'
]),
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://neo.api.projectdiscovery.io/api/v1/agents/user"
payload := strings.NewReader("{\n \"agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_context\": \"<string>\",\n \"custom_tools\": [\n {\n \"command_template\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"input_schema\": {},\n \"is_executable\": true,\n \"script_content\": \"<string>\",\n \"script_path\": \"<string>\",\n \"timeout_seconds\": 123\n }\n ],\n \"description\": \"<string>\",\n \"install_commands\": [\n \"<string>\"\n ],\n \"is_dynamic\": true,\n \"native_tools\": [\n \"<string>\"\n ],\n \"prereq_packages\": [\n \"<string>\"\n ],\n \"require_env_vars\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"verify_commands\": [\n \"<string>\"\n ],\n \"when_to_use\": \"<string>\"\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://neo.api.projectdiscovery.io/api/v1/agents/user")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_context\": \"<string>\",\n \"custom_tools\": [\n {\n \"command_template\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"input_schema\": {},\n \"is_executable\": true,\n \"script_content\": \"<string>\",\n \"script_path\": \"<string>\",\n \"timeout_seconds\": 123\n }\n ],\n \"description\": \"<string>\",\n \"install_commands\": [\n \"<string>\"\n ],\n \"is_dynamic\": true,\n \"native_tools\": [\n \"<string>\"\n ],\n \"prereq_packages\": [\n \"<string>\"\n ],\n \"require_env_vars\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"verify_commands\": [\n \"<string>\"\n ],\n \"when_to_use\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://neo.api.projectdiscovery.io/api/v1/agents/user")
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 \"agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_context\": \"<string>\",\n \"custom_tools\": [\n {\n \"command_template\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"input_schema\": {},\n \"is_executable\": true,\n \"script_content\": \"<string>\",\n \"script_path\": \"<string>\",\n \"timeout_seconds\": 123\n }\n ],\n \"description\": \"<string>\",\n \"install_commands\": [\n \"<string>\"\n ],\n \"is_dynamic\": true,\n \"native_tools\": [\n \"<string>\"\n ],\n \"prereq_packages\": [\n \"<string>\"\n ],\n \"require_env_vars\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"verify_commands\": [\n \"<string>\"\n ],\n \"when_to_use\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"has_dynamic_tools": true,
"has_memory": true,
"id": "<string>",
"name": "<string>",
"tools_count": 123,
"type": "user",
"attached_toolkits": [
{
"attached_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": {
"username": "<string>"
},
"provided_by_editor": true,
"shared_with_team": true,
"tool_count": 123,
"toolkit_id": "<string>",
"visible_to_viewer": true,
"description": "<string>"
}
],
"attached_tools": [
{
"attached_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": {
"username": "<string>"
},
"provided_by_editor": true,
"shared_with_team": true,
"tool_id": "<string>",
"toolkit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"toolkit_id": "<string>"
},
"visible_to_viewer": true,
"description": "<string>"
}
],
"can_edit": true,
"config_hash": "<string>",
"config_version": 123,
"created_at": "2023-11-07T05:31:56Z",
"custom_tools": [
{
"commandTemplate": "<string>",
"description": "<string>",
"id": "<string>",
"inputSchema": {},
"isExecutable": true,
"scriptContent": "<string>",
"scriptPath": "<string>",
"timeoutSeconds": 123
}
],
"custom_tools_count": 123,
"dependencies": {
"secrets": [
{
"name": "<string>",
"state": "shared",
"note": "<string>"
}
],
"toolkits": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": {
"username": "<string>"
},
"provided_by_editor": true,
"state": "shared",
"toolkit_id": "<string>",
"credential_mode": "personal",
"note": "<string>"
}
]
},
"edit_access": "owner",
"editor_count": 123,
"fork_count": 123,
"has_installation_requirements": true,
"install_commands": [
"<string>"
],
"is_owned": true,
"native_tools": [
"<string>"
],
"original_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": {
"username": "<string>"
},
"prereq_packages": [
"<string>"
],
"published_at": "2023-11-07T05:31:56Z",
"require_env_vars": [
"<string>"
],
"system_context": "<string>",
"tags": [
"<string>"
],
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": {
"username": "<string>"
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verify_commands": [
"<string>"
],
"visibility": "public",
"when_to_use": "<string>"
}{
"error": "Bad request",
"code": "user_spending_cap_reached",
"error_id": "<string>",
"kind": "forbidden request",
"message": "<string>",
"param": "<string>",
"turnstile_site_key": "<string>"
}{
"error": "Bad request",
"code": "user_spending_cap_reached",
"error_id": "<string>",
"kind": "forbidden request",
"message": "<string>",
"param": "<string>",
"turnstile_site_key": "<string>"
}{
"error": "Bad request",
"code": "user_spending_cap_reached",
"error_id": "<string>",
"kind": "forbidden request",
"message": "<string>",
"param": "<string>",
"turnstile_site_key": "<string>"
}Agents
Create user agent
Create a new custom agent for the current user. Each user may have up to 50 custom agents.
POST
/
api
/
v1
/
agents
/
user
Create user agent
curl --request POST \
--url https://neo.api.projectdiscovery.io/api/v1/agents/user \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "<string>",
"name": "<string>",
"system_context": "<string>",
"custom_tools": [
{
"command_template": "<string>",
"description": "<string>",
"id": "<string>",
"input_schema": {},
"is_executable": true,
"script_content": "<string>",
"script_path": "<string>",
"timeout_seconds": 123
}
],
"description": "<string>",
"install_commands": [
"<string>"
],
"is_dynamic": true,
"native_tools": [
"<string>"
],
"prereq_packages": [
"<string>"
],
"require_env_vars": [
"<string>"
],
"tags": [
"<string>"
],
"verify_commands": [
"<string>"
],
"when_to_use": "<string>"
}
'import requests
url = "https://neo.api.projectdiscovery.io/api/v1/agents/user"
payload = {
"agent_id": "<string>",
"name": "<string>",
"system_context": "<string>",
"custom_tools": [
{
"command_template": "<string>",
"description": "<string>",
"id": "<string>",
"input_schema": {},
"is_executable": True,
"script_content": "<string>",
"script_path": "<string>",
"timeout_seconds": 123
}
],
"description": "<string>",
"install_commands": ["<string>"],
"is_dynamic": True,
"native_tools": ["<string>"],
"prereq_packages": ["<string>"],
"require_env_vars": ["<string>"],
"tags": ["<string>"],
"verify_commands": ["<string>"],
"when_to_use": "<string>"
}
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({
agent_id: '<string>',
name: '<string>',
system_context: '<string>',
custom_tools: [
{
command_template: '<string>',
description: '<string>',
id: '<string>',
input_schema: {},
is_executable: true,
script_content: '<string>',
script_path: '<string>',
timeout_seconds: 123
}
],
description: '<string>',
install_commands: ['<string>'],
is_dynamic: true,
native_tools: ['<string>'],
prereq_packages: ['<string>'],
require_env_vars: ['<string>'],
tags: ['<string>'],
verify_commands: ['<string>'],
when_to_use: '<string>'
})
};
fetch('https://neo.api.projectdiscovery.io/api/v1/agents/user', 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://neo.api.projectdiscovery.io/api/v1/agents/user",
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([
'agent_id' => '<string>',
'name' => '<string>',
'system_context' => '<string>',
'custom_tools' => [
[
'command_template' => '<string>',
'description' => '<string>',
'id' => '<string>',
'input_schema' => [
],
'is_executable' => true,
'script_content' => '<string>',
'script_path' => '<string>',
'timeout_seconds' => 123
]
],
'description' => '<string>',
'install_commands' => [
'<string>'
],
'is_dynamic' => true,
'native_tools' => [
'<string>'
],
'prereq_packages' => [
'<string>'
],
'require_env_vars' => [
'<string>'
],
'tags' => [
'<string>'
],
'verify_commands' => [
'<string>'
],
'when_to_use' => '<string>'
]),
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://neo.api.projectdiscovery.io/api/v1/agents/user"
payload := strings.NewReader("{\n \"agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_context\": \"<string>\",\n \"custom_tools\": [\n {\n \"command_template\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"input_schema\": {},\n \"is_executable\": true,\n \"script_content\": \"<string>\",\n \"script_path\": \"<string>\",\n \"timeout_seconds\": 123\n }\n ],\n \"description\": \"<string>\",\n \"install_commands\": [\n \"<string>\"\n ],\n \"is_dynamic\": true,\n \"native_tools\": [\n \"<string>\"\n ],\n \"prereq_packages\": [\n \"<string>\"\n ],\n \"require_env_vars\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"verify_commands\": [\n \"<string>\"\n ],\n \"when_to_use\": \"<string>\"\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://neo.api.projectdiscovery.io/api/v1/agents/user")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_context\": \"<string>\",\n \"custom_tools\": [\n {\n \"command_template\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"input_schema\": {},\n \"is_executable\": true,\n \"script_content\": \"<string>\",\n \"script_path\": \"<string>\",\n \"timeout_seconds\": 123\n }\n ],\n \"description\": \"<string>\",\n \"install_commands\": [\n \"<string>\"\n ],\n \"is_dynamic\": true,\n \"native_tools\": [\n \"<string>\"\n ],\n \"prereq_packages\": [\n \"<string>\"\n ],\n \"require_env_vars\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"verify_commands\": [\n \"<string>\"\n ],\n \"when_to_use\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://neo.api.projectdiscovery.io/api/v1/agents/user")
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 \"agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_context\": \"<string>\",\n \"custom_tools\": [\n {\n \"command_template\": \"<string>\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"input_schema\": {},\n \"is_executable\": true,\n \"script_content\": \"<string>\",\n \"script_path\": \"<string>\",\n \"timeout_seconds\": 123\n }\n ],\n \"description\": \"<string>\",\n \"install_commands\": [\n \"<string>\"\n ],\n \"is_dynamic\": true,\n \"native_tools\": [\n \"<string>\"\n ],\n \"prereq_packages\": [\n \"<string>\"\n ],\n \"require_env_vars\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"verify_commands\": [\n \"<string>\"\n ],\n \"when_to_use\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"has_dynamic_tools": true,
"has_memory": true,
"id": "<string>",
"name": "<string>",
"tools_count": 123,
"type": "user",
"attached_toolkits": [
{
"attached_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": {
"username": "<string>"
},
"provided_by_editor": true,
"shared_with_team": true,
"tool_count": 123,
"toolkit_id": "<string>",
"visible_to_viewer": true,
"description": "<string>"
}
],
"attached_tools": [
{
"attached_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": {
"username": "<string>"
},
"provided_by_editor": true,
"shared_with_team": true,
"tool_id": "<string>",
"toolkit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"toolkit_id": "<string>"
},
"visible_to_viewer": true,
"description": "<string>"
}
],
"can_edit": true,
"config_hash": "<string>",
"config_version": 123,
"created_at": "2023-11-07T05:31:56Z",
"custom_tools": [
{
"commandTemplate": "<string>",
"description": "<string>",
"id": "<string>",
"inputSchema": {},
"isExecutable": true,
"scriptContent": "<string>",
"scriptPath": "<string>",
"timeoutSeconds": 123
}
],
"custom_tools_count": 123,
"dependencies": {
"secrets": [
{
"name": "<string>",
"state": "shared",
"note": "<string>"
}
],
"toolkits": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": {
"username": "<string>"
},
"provided_by_editor": true,
"state": "shared",
"toolkit_id": "<string>",
"credential_mode": "personal",
"note": "<string>"
}
]
},
"edit_access": "owner",
"editor_count": 123,
"fork_count": 123,
"has_installation_requirements": true,
"install_commands": [
"<string>"
],
"is_owned": true,
"native_tools": [
"<string>"
],
"original_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": {
"username": "<string>"
},
"prereq_packages": [
"<string>"
],
"published_at": "2023-11-07T05:31:56Z",
"require_env_vars": [
"<string>"
],
"system_context": "<string>",
"tags": [
"<string>"
],
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": {
"username": "<string>"
},
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verify_commands": [
"<string>"
],
"visibility": "public",
"when_to_use": "<string>"
}{
"error": "Bad request",
"code": "user_spending_cap_reached",
"error_id": "<string>",
"kind": "forbidden request",
"message": "<string>",
"param": "<string>",
"turnstile_site_key": "<string>"
}{
"error": "Bad request",
"code": "user_spending_cap_reached",
"error_id": "<string>",
"kind": "forbidden request",
"message": "<string>",
"param": "<string>",
"turnstile_site_key": "<string>"
}{
"error": "Bad request",
"code": "user_spending_cap_reached",
"error_id": "<string>",
"kind": "forbidden request",
"message": "<string>",
"param": "<string>",
"turnstile_site_key": "<string>"
}Authorizations
BearerAuthApiKeyAuth
JWT authentication token
Body
application/json
Unique agent ID (kebab-case)
System prompt for the agent
Show child attributes
Show child attributes
List of native tool IDs to include
When this agent should be triggered
Response
Agent created
Agent ID for user access (use with /agents/user/{agent_id})
Available options:
user Dynamic toolkits attached to this agent (soft-deleted ones excluded). Filled on GET and PATCH of a single agent; omitted on list, create and visibility responses.
Show child attributes
Show child attributes
Single dynamic tools attached to this agent (soft-deleted tools and tools of soft-deleted toolkits excluded). Filled on GET and PATCH of a single agent; omitted on list, create and visibility responses.
Show child attributes
Show child attributes
Whether the caller may edit this agent: always for the owner; for a team-shared agent, when its owner gave the caller edit access.
Show child attributes
Show child attributes
What sharing this agent with its team shared or took back: its required secrets and attached toolkits. Present only on the visibility PATCH response; GET /api/v1/agents/user/{agent_id}/dependencies reads it at any time.
Show child attributes
Show child attributes
Who besides the owner may edit a team-shared agent: owner nobody; team every active team admin or member; members the named editors. Viewers never edit.
Available options:
owner, team, members Number of named editors. 0 unless edit_access is members. Omitted on list responses for an agent whose edit_access is members; GET the agent for the count.
Whether the caller owns this agent.
Show child attributes
Show child attributes
Team whose members can discover, run, and install this agent. Required for team visibility; omitted otherwise.
Who made the latest change. Resolved by GET and PATCH of a single agent; null on other routes and when unknown.
Show child attributes
Show child attributes
Directory entry ID
Available options:
public, private, unlisted, team