Get tool details

GET /tools/{toolId}

Get tool details

cURL

curl --request GET \
  --url https://api.superglue.ai/v1/tools/{toolId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.superglue.ai/v1/tools/{toolId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superglue.ai/v1/tools/{toolId}', 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://api.superglue.ai/v1/tools/{toolId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.superglue.ai/v1/tools/{toolId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.superglue.ai/v1/tools/{toolId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superglue.ai/v1/tools/{toolId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "steps": [
    {
      "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "config": {
        "url": "https://api.example.com/search",
        "method": "GET",
        "type": "request",
        "queryParams": {
          "q": "<<(sourceData) => sourceData.query>>",
          "limit": 10
        },
        "headers": {
          "Content-Type": "application/json",
          "Authorization": "Bearer <<(sourceData) => sourceData.credentials.apiKey>>"
        },
        "body": "{\"query\": \"<<(sourceData) => sourceData.query>>\"}",
        "pagination": {
          "type": "cursorBased",
          "pageSize": "50",
          "cursorPath": "meta.next_cursor",
          "stopCondition": "(response, pageInfo, sourceData) => !response.data.pagination.has_more || pageInfo.totalFetched >= sourceData.maxResults"
        },
        "systemId": "3f7c8d9e-1a2b-4c5d-8e9f-0a1b2c3d4e5f"
      },
      "instruction": "Fetch user details from the API",
      "modify": false,
      "dataSelector": "(sourceData) => sourceData.data.items",
      "failureBehavior": "fail"
    }
  ],
  "name": "Web Search",
  "version": "2.1.0",
  "instruction": "Search the web for the given query and return relevant results",
  "inputSchema": {
    "type": "object",
    "properties": {
      "query": {
        "type": "string"
      },
      "maxResults": {
        "type": "integer",
        "default": 10
      }
    },
    "required": [
      "query"
    ]
  },
  "outputSchema": {},
  "outputTransform": "(sourceData) => sourceData.map(item => ({ id: item.id, title: item.name }))",
  "folder": "integrations/payments",
  "archived": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "Invalid input parameters"
  }
}

Authorizations

Authorization · string · header · required

Static API key authentication using Bearer token scheme. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Alternatively, you can use the token query parameter to authenticate.

API keys can be generated in your superglue dashboard.

Path Parameters

toolId · string · required

Response

200

application/json

Tool details

A multi-step workflow tool that executes one or more protocol-specific operations

id · string · required

Example:

"550e8400-e29b-41d4-a716-446655440000"

steps · object[] · required

Ordered execution steps that make up this tool

Minimum array length: 1

Show child attributes

name · string

Example:

"Web Search"

version · string

Semantic version string (major.minor.patch)

Pattern: ^\d+\.\d+\.\d+$

Example:

"2.1.0"

instruction · string

Human-readable instruction describing what the tool does

Example:

"Search the web for the given query and return relevant results"

inputSchema · object

JSON Schema for tool inputs

Example:

{
  "type": "object",
  "properties": {
    "query": { "type": "string" },
    "maxResults": { "type": "integer", "default": 10 }
  },
  "required": ["query"]
}

outputSchema · object

JSON Schema for tool outputs (after transformations applied)

outputTransform · string

JavaScript function for final output transformation. Format: (sourceData) => expression

Example:

"(sourceData) => sourceData.map(item => ({ id: item.id, title: item.name }))"

folder · string

Folder path for organizing tools

Example:

"integrations/payments"

archived · boolean · default: false

Whether this tool is archived (if so, it will not be listed in the UI and cannot be run)

createdAt · string<date-time>

updatedAt · string<date-time>