Get tool details

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "steps": [
    {
      "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "url": "https://api.example.com/search",
      "method": "GET",
      "systemId": "3f7c8d9e-1a2b-4c5d-8e9f-0a1b2c3d4e5f",
      "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) => !response.data.pagination.has_more"
      },
      "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 }))",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

GET

tools

{toolId}

Get tool details

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "steps": [
    {
      "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "url": "https://api.example.com/search",
      "method": "GET",
      "systemId": "3f7c8d9e-1a2b-4c5d-8e9f-0a1b2c3d4e5f",
      "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) => !response.data.pagination.has_more"
      },
      "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 }))",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

API keys can be generated in your superglue dashboard.

Path Parameters

toolId

string

required

Response

Tool details

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

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

steps.id

string

required

Unique identifier for this step

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

steps.url

string

required

Full URL including protocol. Examples:

HTTP: https://api.example.com/search
Postgres: postgres://user:pass@host:5432/database
FTP: ftp://user:pass@host:21/path
SFTP: sftp://user:pass@host:22/path

Example:

"https://api.example.com/search"

steps.method

enum<string>

required

HTTP method. For non-HTTP protocols, use POST.

Available options:

GET,

POST,

PUT,

DELETE,

PATCH,

HEAD,

OPTIONS

Example:

"GET"

steps.systemId

string

required

System to use for stored credentials and documentation

Example:

"3f7c8d9e-1a2b-4c5d-8e9f-0a1b2c3d4e5f"

steps.queryParams

object

URL query parameters (HTTP only). Supports template expressions with <<(sourceData) => ...>> syntax.

Example:

{
  "q": "<<(sourceData) => sourceData.query>>",
  "limit": 10
}

steps.headers

object

HTTP headers (HTTP only). Supports template expressions with <<(sourceData) => ...>> syntax.

Example:

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <<(sourceData) => sourceData.credentials.apiKey>>"
}

steps.body

string

Request body (protocol-specific). Supports template expressions with <<(sourceData) => ...>> syntax.

HTTP: Any content (JSON, XML, form data, etc.) Example: '{"query": "<<(sourceData) => sourceData.query>>"}'

Postgres: JSON with query and optional params Example: '{"query": "SELECT * FROM users WHERE id = $1", "params": ["<<(sourceData) => sourceData.userId>>"]}'

FTP/SFTP: JSON with operation, path, and optional content Example: '{"operation": "get", "path": "/data/file.csv"}' Example: '{"operation": "list", "path": "/data"}' Example: '{"operation": "put", "path": "/data/file.txt", "content": "<<(sourceData) => sourceData.fileContent>>"}'

Example:

"{\"query\": \"<<(sourceData) => sourceData.query>>\"}"

steps.pagination

object

Pagination configuration (HTTP/HTTPS only, not applicable to Postgres/FTP)

Show child attributes

steps.pagination.type

enum<string>

required

Available options:

offsetBased,

pageBased,

cursorBased,

disabled

Example:

"cursorBased"

steps.pagination.pageSize

string

Number of items per page. Becomes available as <<(sourceData) => sourceData.limit>> in request templates.

Example:

"50"

steps.pagination.cursorPath

string

JSONPath to extract next page cursor from response body (e.g. "meta.next_cursor" for {meta:{next_cursor:"abc"}})

Example:

"meta.next_cursor"

steps.pagination.stopCondition

string

JavaScript function to determine when to stop pagination. Format: (response, pageInfo) => boolean

response: Object with {data: ..., headers: ...} - access response body via response.data
pageInfo: Object with {page: number, offset: number, cursor: any, totalFetched: number}
Return true to STOP pagination, false to continue

Example:

"(response, pageInfo) => !response.data.pagination.has_more"

steps.instruction

string

Human-readable instruction describing what this step does

Example:

"Fetch user details from the API"

steps.modify

boolean

default:false

Whether this step can be modified by the self-healing system

steps.dataSelector

string

JavaScript function to select data for loop execution. Format: (sourceData) => expression

Example:

"(sourceData) => sourceData.data.items"

steps.failureBehavior

enum<string>

default:fail

How to handle step failures (fail stops execution, continue proceeds to next step)

Available options:

fail,

continue

name

string

Example:

"Web Search"

version

string

Semantic version string (major.minor.patch)

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 }))"

createdAt

string<date-time>

updatedAt

string<date-time>

List tools Run a tool

⌘I

Getting Started

Guides

SDK Reference

API Reference

Get tool details

Authorizations

Path Parameters

Response