Logo
Search
Docs

Assistant tools picker

GET https://app.sulus.ai/api/assistants/tools

Tools available to attach to an assistant

Authentication

Send a bearer token created on your dashboard's Developer page:

Authorization: Bearer <YOUR_API_KEY>

Query parameters

include array Optional Nullable

Already-attached tool ids so their labels resolve even outside your scope.

Validation: array or comma-separated tool ids
owner_id integer Optional Nullable

List tools of the assistant's owner instead of the caller.

Validation: integer — honoured for admin roles only

Errors

StatusMeaningBody
401 Missing or invalid bearer token
403 Feature assistants not enabled for the account

Notes

  • Global (platform) tools sort first with scope "global". locked entries cannot be detached.
curl --request GET \
  --url https://app.sulus.ai/api/assistants/tools \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
import requests

url = "https://app.sulus.ai/api/assistants/tools"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}

response = requests.get(url, headers=headers)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://app.sulus.ai/api/assistants/tools"
	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
Response 200 
{
    "success": true,
    "data": [
        {
            "value": "e1d2c3b4-5a69-4788-9f0e-1a2b3c4d5e6f",
            "label": "Knowledge Base",
            "description": "Platform knowledge-base search tool",
            "type": "function",
            "scope": "global",
            "locked": true
        },
        {
            "value": "c3d4e5f6-7a8b-49c0-8d1e-2f3a4b5c6d7e",
            "label": "Book Appointment",
            "description": "Books a new appointment on the caller's behalf and confirms the time back to them.",
            "type": "function",
            "scope": "own",
            "locked": false
        }
    ],
    "locked_tool_ids": [
        "e1d2c3b4-5a69-4788-9f0e-1a2b3c4d5e6f"
    ]
}