Logo
Search
Docs

Get tool

GET https://app.sulus.ai/api/tools/{id}

Retrieve one tool

Authentication

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

Authorization: Bearer <YOUR_API_KEY>

Path parameters

id string Required

The tool's public id.

Validation: the tool's external_tool_id (UUID, or draft_… slug for drafts)
Stored in tools.external_tool_id

Errors

StatusMeaningBody
404 Tool not found, or outside your account scope {"success":false,"message":"Tool not found"}
401 Missing or invalid bearer token
403 Feature tools not enabled for the account

Notes

  • coreData is a live read of the upstream tool for a published tool, or null for a draft (drafts skip the live read entirely).
curl --request GET \
  --url https://app.sulus.ai/api/tools/{id} \
  --header 'Authorization: Bearer <YOUR_API_KEY>'
import requests

url = "https://app.sulus.ai/api/tools/{id}"
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/tools/{id}"
	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": {
        "name": "Check Order Status",
        "user_id": 42,
        "external_tool_id": "d4e5f6a7-8b9c-4a1d-9e2f-3a4b5c6d7e8f",
        "status": "published",
        "created_by": 42,
        "reseller_id": "f1e2d3c4-b5a6-4978-8901-234567890abc",
        "workspace_id": "9a8b7c6d-5e4f-4a3b-9c8d-7e6f5a4b3c2d",
        "type": "apiRequest",
        "description": "Looks up an order by ID and returns its current status.",
        "function_def": {
            "name": "check_order_status"
        },
        "server": {
            "url": "https://api.example-business.com/orders/lookup",
            "method": "POST",
            "timeoutSeconds": 20,
            "credentialId": "3f9c2a10-6b4e-4a2d-9f0a-1c2d3e4f5a6b"
        },
        "variable_extraction_plan": {
            "properties": [
                {
                    "name": "orderStatus",
                    "type": "string",
                    "description": "Current status of the order",
                    "required": false
                }
            ]
        },
        "destinations": null,
        "rejection_plan": null,
        "messages": [
            {
                "type": "request-start",
                "content": "Let me check on that order for you."
            }
        ],
        "metadata": {
            "category": "orders"
        },
        "async": false,
        "created_at": "2026-06-01T14:22:03+00:00",
        "updated_at": "2026-07-15T09:10:44+00:00",
        "user": {
            "id": 42,
            "name": "Jane Cooper",
            "email": "[email protected]"
        },
        "creator": {
            "id": 42,
            "name": "Jane Cooper",
            "email": "[email protected]"
        },
        "read_only": false,
        "coreData": {
            "id": "d4e5f6a7-8b9c-4a1d-9e2f-3a4b5c6d7e8f"
        }
    }
}