List tools

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

{
  "data": [
    {
      "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"
    }
  ],
  "page": 1,
  "limit": 50,
  "total": 127,
  "hasMore": true
}

GET

tools

List tools

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

{
  "data": [
    {
      "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"
    }
  ],
  "page": 1,
  "limit": 50,
  "total": 127,
  "hasMore": true
}

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.

Query Parameters

page

integer

default:1

limit

integer

default:50

Required range: x <= 100

Response

200 - application/json

List of tools (latest versions only)

data

object[]

Show child attributes

data.id

string

required

Example:

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

data.steps

object[]

required

Ordered execution steps that make up this tool

Minimum array length: 1

Show child attributes

data.steps.id

string

required

Unique identifier for this step

Example:

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

data.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"

data.steps.method

enum<string>

required

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

Available options:

GET,

POST,

PUT,

DELETE,

PATCH,

HEAD,

OPTIONS

Example:

"GET"

data.steps.systemId

string

required

System to use for stored credentials and documentation

Example:

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

data.steps.queryParams

object

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

Example:

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

data.steps.headers

object

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

Example:

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

data.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>>\"}"

data.steps.pagination

object

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

Show child attributes

data.steps.pagination.type

enum<string>

required

Available options:

offsetBased,

pageBased,

cursorBased,

disabled

Example:

"cursorBased"

data.steps.pagination.pageSize

string

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

Example:

"50"

data.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"

data.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"

data.steps.instruction

string

Human-readable instruction describing what this step does

Example:

"Fetch user details from the API"

data.steps.modify

boolean

default:false

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

data.steps.dataSelector

string

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

Example:

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

data.steps.failureBehavior

enum<string>

default:fail

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

Available options:

fail,

continue

data.name

string

Example:

"Web Search"

data.version

string

Semantic version string (major.minor.patch)

Example:

"2.1.0"

data.instruction

string

Human-readable instruction describing what the tool does

Example:

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

data.inputSchema

object

JSON Schema for tool inputs

Example:

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

data.outputSchema

object

JSON Schema for tool outputs (after transformations applied)

data.outputTransform

string

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

Example:

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

data.createdAt

string<date-time>

data.updatedAt

string<date-time>

page

integer

Example:

1

limit

integer

Example:

50

total

integer

Example:

127

hasMore

boolean

Example:

true

Types Get tool details

⌘I

Getting Started

Guides

SDK Reference

API Reference

List tools

Authorizations

Query Parameters

Response