Add A New Tool

curl --request POST \
  --url https://app.agentcloud.dev/{resourceSlug}/forms/tool/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: tool.json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "data": {
    "name": "<string>",
    "runtime": "<string>",
    "builtin": true,
    "description": "<string>",
    "apiKey": "<string>",
    "environmentVariables": {},
    "parameters": {
      "properties": {},
      "required": [
        "<string>"
      ]
    },
    "code": "<string>",
    "requirements": "<string>",
    "openAPIMatchKey": "<string>"
  },
  "_id": "<string>",
  "orgId": "<string>",
  "teamId": "<string>",
  "asdf": "<string>",
  "retriever_config": {
    "metadata_field_info": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "k": 123
  },
  "datasourceId": "<string>",
  "hidden": true,
  "functionId": "<string>",
  "revisionId": "<string>",
  "functionLogs": "<string>"
}'

import requests

url = "https://app.agentcloud.dev/{resourceSlug}/forms/tool/add"

payload = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "tool.json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'tool.json'},
  body: '{\n  "name": "<string>",\n  "description": "<string>",\n  "data": {\n    "name": "<string>",\n    "runtime": "<string>",\n    "builtin": true,\n    "description": "<string>",\n    "apiKey": "<string>",\n    "environmentVariables": {},\n    "parameters": {\n      "properties": {},\n      "required": [\n        "<string>"\n      ]\n    },\n    "code": "<string>",\n    "requirements": "<string>",\n    "openAPIMatchKey": "<string>"\n  },\n  "_id": "<string>",\n  "orgId": "<string>",\n  "teamId": "<string>",\n  "asdf": "<string>",\n  "retriever_config": {\n    "metadata_field_info": [\n      {\n        "name": "<string>",\n        "description": "<string>"\n      }\n    ],\n    "k": 123\n  },\n  "datasourceId": "<string>",\n  "hidden": true,\n  "functionId": "<string>",\n  "revisionId": "<string>",\n  "functionLogs": "<string>"\n}'
};

fetch('https://app.agentcloud.dev/{resourceSlug}/forms/tool/add', 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://app.agentcloud.dev/{resourceSlug}/forms/tool/add",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: tool.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://app.agentcloud.dev/{resourceSlug}/forms/tool/add"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "tool.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://app.agentcloud.dev/{resourceSlug}/forms/tool/add")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "tool.json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.agentcloud.dev/{resourceSlug}/forms/tool/add")

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"] = 'tool.json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "<string>",
  "redirect": "<string>"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

POST

{resourceSlug}

forms

tool

add

Add A New Tool

curl --request POST \
  --url https://app.agentcloud.dev/{resourceSlug}/forms/tool/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: tool.json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "data": {
    "name": "<string>",
    "runtime": "<string>",
    "builtin": true,
    "description": "<string>",
    "apiKey": "<string>",
    "environmentVariables": {},
    "parameters": {
      "properties": {},
      "required": [
        "<string>"
      ]
    },
    "code": "<string>",
    "requirements": "<string>",
    "openAPIMatchKey": "<string>"
  },
  "_id": "<string>",
  "orgId": "<string>",
  "teamId": "<string>",
  "asdf": "<string>",
  "retriever_config": {
    "metadata_field_info": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "k": 123
  },
  "datasourceId": "<string>",
  "hidden": true,
  "functionId": "<string>",
  "revisionId": "<string>",
  "functionLogs": "<string>"
}'

import requests

url = "https://app.agentcloud.dev/{resourceSlug}/forms/tool/add"

payload = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "tool.json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'tool.json'},
  body: '{\n  "name": "<string>",\n  "description": "<string>",\n  "data": {\n    "name": "<string>",\n    "runtime": "<string>",\n    "builtin": true,\n    "description": "<string>",\n    "apiKey": "<string>",\n    "environmentVariables": {},\n    "parameters": {\n      "properties": {},\n      "required": [\n        "<string>"\n      ]\n    },\n    "code": "<string>",\n    "requirements": "<string>",\n    "openAPIMatchKey": "<string>"\n  },\n  "_id": "<string>",\n  "orgId": "<string>",\n  "teamId": "<string>",\n  "asdf": "<string>",\n  "retriever_config": {\n    "metadata_field_info": [\n      {\n        "name": "<string>",\n        "description": "<string>"\n      }\n    ],\n    "k": 123\n  },\n  "datasourceId": "<string>",\n  "hidden": true,\n  "functionId": "<string>",\n  "revisionId": "<string>",\n  "functionLogs": "<string>"\n}'
};

fetch('https://app.agentcloud.dev/{resourceSlug}/forms/tool/add', 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://app.agentcloud.dev/{resourceSlug}/forms/tool/add",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: tool.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://app.agentcloud.dev/{resourceSlug}/forms/tool/add"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "tool.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://app.agentcloud.dev/{resourceSlug}/forms/tool/add")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "tool.json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.agentcloud.dev/{resourceSlug}/forms/tool/add")

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"] = 'tool.json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {\n    \"name\": \"<string>\",\n    \"runtime\": \"<string>\",\n    \"builtin\": true,\n    \"description\": \"<string>\",\n    \"apiKey\": \"<string>\",\n    \"environmentVariables\": {},\n    \"parameters\": {\n      \"properties\": {},\n      \"required\": [\n        \"<string>\"\n      ]\n    },\n    \"code\": \"<string>\",\n    \"requirements\": \"<string>\",\n    \"openAPIMatchKey\": \"<string>\"\n  },\n  \"_id\": \"<string>\",\n  \"orgId\": \"<string>\",\n  \"teamId\": \"<string>\",\n  \"asdf\": \"<string>\",\n  \"retriever_config\": {\n    \"metadata_field_info\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"k\": 123\n  },\n  \"datasourceId\": \"<string>\",\n  \"hidden\": true,\n  \"functionId\": \"<string>\",\n  \"revisionId\": \"<string>\",\n  \"functionLogs\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "<string>",
  "redirect": "<string>"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

resourceSlug

string

required

The resourceSlug is a URL parameter of the teamId associated with the user. Anywhere the resourceSlug is used can be interpreted as a teamId. Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

Body

tool.json

JSON body containing the tool object with at least the required fields. Do not include an '_id', as this will be automatically generated.

Represents a tool within the system, including its configuration, state, and associated retrievers.

name

string

required

The name of the tool.

description

string

required

A detailed description of the tool.

type

enum<string>

required

The type of tool.

Available options:

function,

rag

data

object

required

Data related to the tool, including runtime, environment variables, and more.

Show child attributes

_id

string

Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

orgId

string

Identifier of the organization to which the tool belongs.

teamId

string

Identifier of the team to which the tool belongs.

asdf

string

The schema associated with the tool.

retriever_type

enum<string>

The type of retriever used by the tool.

Available options:

raw,

self_query,

time_weighted,

multi_query

retriever_config

object

Configuration for the self-query retriever.

Option 1
Option 2

Show child attributes

datasourceId

string

Identifier of the datasource associated with the tool.

state

enum<string>

The current state of the tool.

Available options:

pending,

ready,

error

icon

object

Icon associated with the tool.

Show child attributes

hidden

boolean

Indicates whether the tool is hidden.

functionId

string

Identifier of the function associated with the tool.

revisionId

string

Identifier of the tool's revision.

functionLogs

string

Logs related to the function's execution.

Response

Successful operation, redirect to '/{resourceSlug}/tools'.

Server response after successsfully adding a new object

_id

string

The unique Mongo id of the newly inserted object.

redirect

string

a string containing the redirect link to get all objects after a successful insertion.