Skip to main content
POST
/
agents
/
{id}
/
custom-tools
Create Custom Tool
curl --request POST \
  --url https://api.revring.ai/v1/agents/{id}/custom-tools \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "webhookUrl": "<string>",
  "enabled": true,
  "schema": {},
  "headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "queryParams": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "sendRawRequestBody": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "webhookUrl": "<string>",
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "schema": {},
    "headers": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "queryParams": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "sendRawRequestBody": true
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Path Parameters

​
id
string<uuid>
required

Agent ID

Body

application/json
​
name
string
required
Maximum string length: 64
​
webhookUrl
string<uri>
required
​
enabled
boolean
default:true
​
schema
object

OpenAI function calling schema

​
httpMethod
enum<string>

HTTP method used when calling the webhook. Defaults to POST.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
​
headers
object[] | null

Custom HTTP headers to include in webhook requests

​
queryParams
object[] | null

Custom query parameters appended to the webhook URL

​
sendRawRequestBody
boolean

When true, sends tool arguments directly as the request body instead of the default wrapper

Response

Custom tool created

​
data
object

Custom function calling tool for agents