tools

create a tool

an HTTP endpoint an agent can use. before_call tools run at the start of every call and fill variables from their outputs; during_call tools are handed to the model as functions it can invoke mid-call (their llmParams become the function’s arguments). {token} inside url, params, headers and body is filled from the model’s arguments, then the account’s variables, then the context params. credentials are write-only: send auth.token / auth.password here, and the API only ever reports hasSecret. name must match ^[A-Za-z][A-Za-z0-9_]*$ and be unique on the account.

POST

tools

create a tool

curl --request POST \
  --url https://silk-api.rumik.ai/v1/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "lookup_account",
  "description": "looks the caller's account up by phone number",
  "kind": "before_call",
  "config": {
    "action": "get",
    "method": "GET",
    "url": "https://api.example.com/v1/accounts",
    "params": [
      {
        "name": "phone",
        "value": "{phone_number}"
      }
    ],
    "headers": [
      {
        "name": "Accept",
        "value": "application/json"
      }
    ],
    "auth": {
      "type": "bearer",
      "token": "sk-…"
    },
    "timeoutMs": 3000,
    "outputs": [
      {
        "name": "firstName",
        "path": ""
      },
      {
        "name": "plan",
        "path": "account.plan"
      }
    ]
  }
}
EOF

import requests

url = "https://silk-api.rumik.ai/v1/tools"

payload = {
    "name": "lookup_account",
    "description": "looks the caller's account up by phone number",
    "kind": "before_call",
    "config": {
        "action": "get",
        "method": "GET",
        "url": "https://api.example.com/v1/accounts",
        "params": [
            {
                "name": "phone",
                "value": "{phone_number}"
            }
        ],
        "headers": [
            {
                "name": "Accept",
                "value": "application/json"
            }
        ],
        "auth": {
            "type": "bearer",
            "token": "sk-…"
        },
        "timeoutMs": 3000,
        "outputs": [
            {
                "name": "firstName",
                "path": ""
            },
            {
                "name": "plan",
                "path": "account.plan"
            }
        ]
    }
}
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: 'lookup_account',
    description: 'looks the caller\'s account up by phone number',
    kind: 'before_call',
    config: {
      action: 'get',
      method: 'GET',
      url: 'https://api.example.com/v1/accounts',
      params: [{name: 'phone', value: '{phone_number}'}],
      headers: [{name: 'Accept', value: 'application/json'}],
      auth: {type: 'bearer', token: 'sk-…'},
      timeoutMs: 3000,
      outputs: [{name: 'firstName', path: ''}, {name: 'plan', path: 'account.plan'}]
    }
  })
};

fetch('https://silk-api.rumik.ai/v1/tools', 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://silk-api.rumik.ai/v1/tools",
  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' => 'lookup_account',
    'description' => 'looks the caller\'s account up by phone number',
    'kind' => 'before_call',
    'config' => [
        'action' => 'get',
        'method' => 'GET',
        'url' => 'https://api.example.com/v1/accounts',
        'params' => [
                [
                                'name' => 'phone',
                                'value' => '{phone_number}'
                ]
        ],
        'headers' => [
                [
                                'name' => 'Accept',
                                'value' => 'application/json'
                ]
        ],
        'auth' => [
                'type' => 'bearer',
                'token' => 'sk-…'
        ],
        'timeoutMs' => 3000,
        'outputs' => [
                [
                                'name' => 'firstName',
                                'path' => ''
                ],
                [
                                'name' => 'plan',
                                'path' => 'account.plan'
                ]
        ]
    ]
  ]),
  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://silk-api.rumik.ai/v1/tools"

	payload := strings.NewReader("{\n  \"name\": \"lookup_account\",\n  \"description\": \"looks the caller's account up by phone number\",\n  \"kind\": \"before_call\",\n  \"config\": {\n    \"action\": \"get\",\n    \"method\": \"GET\",\n    \"url\": \"https://api.example.com/v1/accounts\",\n    \"params\": [\n      {\n        \"name\": \"phone\",\n        \"value\": \"{phone_number}\"\n      }\n    ],\n    \"headers\": [\n      {\n        \"name\": \"Accept\",\n        \"value\": \"application/json\"\n      }\n    ],\n    \"auth\": {\n      \"type\": \"bearer\",\n      \"token\": \"sk-…\"\n    },\n    \"timeoutMs\": 3000,\n    \"outputs\": [\n      {\n        \"name\": \"firstName\",\n        \"path\": \"\"\n      },\n      {\n        \"name\": \"plan\",\n        \"path\": \"account.plan\"\n      }\n    ]\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://silk-api.rumik.ai/v1/tools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"lookup_account\",\n  \"description\": \"looks the caller's account up by phone number\",\n  \"kind\": \"before_call\",\n  \"config\": {\n    \"action\": \"get\",\n    \"method\": \"GET\",\n    \"url\": \"https://api.example.com/v1/accounts\",\n    \"params\": [\n      {\n        \"name\": \"phone\",\n        \"value\": \"{phone_number}\"\n      }\n    ],\n    \"headers\": [\n      {\n        \"name\": \"Accept\",\n        \"value\": \"application/json\"\n      }\n    ],\n    \"auth\": {\n      \"type\": \"bearer\",\n      \"token\": \"sk-…\"\n    },\n    \"timeoutMs\": 3000,\n    \"outputs\": [\n      {\n        \"name\": \"firstName\",\n        \"path\": \"\"\n      },\n      {\n        \"name\": \"plan\",\n        \"path\": \"account.plan\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/tools")

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\": \"lookup_account\",\n  \"description\": \"looks the caller's account up by phone number\",\n  \"kind\": \"before_call\",\n  \"config\": {\n    \"action\": \"get\",\n    \"method\": \"GET\",\n    \"url\": \"https://api.example.com/v1/accounts\",\n    \"params\": [\n      {\n        \"name\": \"phone\",\n        \"value\": \"{phone_number}\"\n      }\n    ],\n    \"headers\": [\n      {\n        \"name\": \"Accept\",\n        \"value\": \"application/json\"\n      }\n    ],\n    \"auth\": {\n      \"type\": \"bearer\",\n      \"token\": \"sk-…\"\n    },\n    \"timeoutMs\": 3000,\n    \"outputs\": [\n      {\n        \"name\": \"firstName\",\n        \"path\": \"\"\n      },\n      {\n        \"name\": \"plan\",\n        \"path\": \"account.plan\"\n      }\n    ]\n  }\n}"

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

{
  "id": "019f8e32-4d60-7f71-ac8d-9e0f1a2b3c4d",
  "name": "lookup_account",
  "description": "looks the caller's account up by phone number",
  "kind": "before_call",
  "config": {
    "action": "get",
    "performedAction": "end_call",
    "curl": "",
    "method": "GET",
    "url": "https://api.example.com/v1/accounts",
    "headers": [
      {
        "name": "Accept",
        "value": "application/json"
      }
    ],
    "params": [
      {
        "name": "phone",
        "value": "{phone_number}"
      }
    ],
    "body": "",
    "timeoutMs": 3000,
    "waitForResponse": true,
    "auth": {
      "type": "bearer",
      "headerName": "X-API-Key",
      "username": "",
      "hasSecret": true
    },
    "llmParams": [],
    "outputs": [
      {
        "name": "firstName",
        "path": ""
      },
      {
        "name": "plan",
        "path": "account.plan"
      }
    ]
  },
  "isDefault": false,
  "createdAt": "2026-09-11T10:00:00Z",
  "updatedAt": "2026-09-11T10:00:00Z"
}

Authorizations

Authorization

string

header

required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Body

application/json

name

string

required

^[A-Za-z][A-Za-z0-9_]*$, up to 64 characters, unique on the account. prompts attach the tool as {{name}}.

Maximum string length: 64

description

string

required

what the tool does — for a during_call tool this is what the model reads to decide when to call it.

Required string length: 1 - 1000

kind

enum<string>

required

before_call (runs at call start, feeds variables) or during_call (a function the model can invoke).

Available options:

before_call,

during_call

config

ToolConfigInput · object

the HTTP call to make.

Show child attributes

Response

created.

a tool as stored. the credential is never returned.

string

required

the tool's id (default-… for built-ins).

name

string

required

description

string

required

kind

enum<string>

required

When in a call's life the agent reaches for the tool.

Available options:

before_call,

during_call

config

ToolConfig · object

required

Server-constructed (serialization_alias), see :class:AgentToolAuthView.

Show child attributes

isDefault

boolean

default:false

true for the platform's built-in tools, which cannot be edited or deleted.

createdAt

string<date-time> | null

updatedAt

string<date-time> | null

create a tool

curl --request POST \
  --url https://silk-api.rumik.ai/v1/tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "lookup_account",
  "description": "looks the caller's account up by phone number",
  "kind": "before_call",
  "config": {
    "action": "get",
    "method": "GET",
    "url": "https://api.example.com/v1/accounts",
    "params": [
      {
        "name": "phone",
        "value": "{phone_number}"
      }
    ],
    "headers": [
      {
        "name": "Accept",
        "value": "application/json"
      }
    ],
    "auth": {
      "type": "bearer",
      "token": "sk-…"
    },
    "timeoutMs": 3000,
    "outputs": [
      {
        "name": "firstName",
        "path": ""
      },
      {
        "name": "plan",
        "path": "account.plan"
      }
    ]
  }
}
EOF

import requests

url = "https://silk-api.rumik.ai/v1/tools"

payload = {
    "name": "lookup_account",
    "description": "looks the caller's account up by phone number",
    "kind": "before_call",
    "config": {
        "action": "get",
        "method": "GET",
        "url": "https://api.example.com/v1/accounts",
        "params": [
            {
                "name": "phone",
                "value": "{phone_number}"
            }
        ],
        "headers": [
            {
                "name": "Accept",
                "value": "application/json"
            }
        ],
        "auth": {
            "type": "bearer",
            "token": "sk-…"
        },
        "timeoutMs": 3000,
        "outputs": [
            {
                "name": "firstName",
                "path": ""
            },
            {
                "name": "plan",
                "path": "account.plan"
            }
        ]
    }
}
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: 'lookup_account',
    description: 'looks the caller\'s account up by phone number',
    kind: 'before_call',
    config: {
      action: 'get',
      method: 'GET',
      url: 'https://api.example.com/v1/accounts',
      params: [{name: 'phone', value: '{phone_number}'}],
      headers: [{name: 'Accept', value: 'application/json'}],
      auth: {type: 'bearer', token: 'sk-…'},
      timeoutMs: 3000,
      outputs: [{name: 'firstName', path: ''}, {name: 'plan', path: 'account.plan'}]
    }
  })
};

fetch('https://silk-api.rumik.ai/v1/tools', 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://silk-api.rumik.ai/v1/tools",
  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' => 'lookup_account',
    'description' => 'looks the caller\'s account up by phone number',
    'kind' => 'before_call',
    'config' => [
        'action' => 'get',
        'method' => 'GET',
        'url' => 'https://api.example.com/v1/accounts',
        'params' => [
                [
                                'name' => 'phone',
                                'value' => '{phone_number}'
                ]
        ],
        'headers' => [
                [
                                'name' => 'Accept',
                                'value' => 'application/json'
                ]
        ],
        'auth' => [
                'type' => 'bearer',
                'token' => 'sk-…'
        ],
        'timeoutMs' => 3000,
        'outputs' => [
                [
                                'name' => 'firstName',
                                'path' => ''
                ],
                [
                                'name' => 'plan',
                                'path' => 'account.plan'
                ]
        ]
    ]
  ]),
  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://silk-api.rumik.ai/v1/tools"

	payload := strings.NewReader("{\n  \"name\": \"lookup_account\",\n  \"description\": \"looks the caller's account up by phone number\",\n  \"kind\": \"before_call\",\n  \"config\": {\n    \"action\": \"get\",\n    \"method\": \"GET\",\n    \"url\": \"https://api.example.com/v1/accounts\",\n    \"params\": [\n      {\n        \"name\": \"phone\",\n        \"value\": \"{phone_number}\"\n      }\n    ],\n    \"headers\": [\n      {\n        \"name\": \"Accept\",\n        \"value\": \"application/json\"\n      }\n    ],\n    \"auth\": {\n      \"type\": \"bearer\",\n      \"token\": \"sk-…\"\n    },\n    \"timeoutMs\": 3000,\n    \"outputs\": [\n      {\n        \"name\": \"firstName\",\n        \"path\": \"\"\n      },\n      {\n        \"name\": \"plan\",\n        \"path\": \"account.plan\"\n      }\n    ]\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://silk-api.rumik.ai/v1/tools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"lookup_account\",\n  \"description\": \"looks the caller's account up by phone number\",\n  \"kind\": \"before_call\",\n  \"config\": {\n    \"action\": \"get\",\n    \"method\": \"GET\",\n    \"url\": \"https://api.example.com/v1/accounts\",\n    \"params\": [\n      {\n        \"name\": \"phone\",\n        \"value\": \"{phone_number}\"\n      }\n    ],\n    \"headers\": [\n      {\n        \"name\": \"Accept\",\n        \"value\": \"application/json\"\n      }\n    ],\n    \"auth\": {\n      \"type\": \"bearer\",\n      \"token\": \"sk-…\"\n    },\n    \"timeoutMs\": 3000,\n    \"outputs\": [\n      {\n        \"name\": \"firstName\",\n        \"path\": \"\"\n      },\n      {\n        \"name\": \"plan\",\n        \"path\": \"account.plan\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://silk-api.rumik.ai/v1/tools")

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\": \"lookup_account\",\n  \"description\": \"looks the caller's account up by phone number\",\n  \"kind\": \"before_call\",\n  \"config\": {\n    \"action\": \"get\",\n    \"method\": \"GET\",\n    \"url\": \"https://api.example.com/v1/accounts\",\n    \"params\": [\n      {\n        \"name\": \"phone\",\n        \"value\": \"{phone_number}\"\n      }\n    ],\n    \"headers\": [\n      {\n        \"name\": \"Accept\",\n        \"value\": \"application/json\"\n      }\n    ],\n    \"auth\": {\n      \"type\": \"bearer\",\n      \"token\": \"sk-…\"\n    },\n    \"timeoutMs\": 3000,\n    \"outputs\": [\n      {\n        \"name\": \"firstName\",\n        \"path\": \"\"\n      },\n      {\n        \"name\": \"plan\",\n        \"path\": \"account.plan\"\n      }\n    ]\n  }\n}"

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

{
  "id": "019f8e32-4d60-7f71-ac8d-9e0f1a2b3c4d",
  "name": "lookup_account",
  "description": "looks the caller's account up by phone number",
  "kind": "before_call",
  "config": {
    "action": "get",
    "performedAction": "end_call",
    "curl": "",
    "method": "GET",
    "url": "https://api.example.com/v1/accounts",
    "headers": [
      {
        "name": "Accept",
        "value": "application/json"
      }
    ],
    "params": [
      {
        "name": "phone",
        "value": "{phone_number}"
      }
    ],
    "body": "",
    "timeoutMs": 3000,
    "waitForResponse": true,
    "auth": {
      "type": "bearer",
      "headerName": "X-API-Key",
      "username": "",
      "hasSecret": true
    },
    "llmParams": [],
    "outputs": [
      {
        "name": "firstName",
        "path": ""
      },
      {
        "name": "plan",
        "path": "account.plan"
      }
    ]
  },
  "isDefault": false,
  "createdAt": "2026-09-11T10:00:00Z",
  "updatedAt": "2026-09-11T10:00:00Z"
}

documentation

sdk

integrations

cookbook

api reference

create a tool

Authorizations

Body

Response