Runs

List runs

get/runs

Request

  • Base URL
    https://api.superglue.cloud/v1
  • Auth
    HTTP bearer

Query parameters

toolIdstring

Filter by saved tool ID.

searchstring

Search run IDs, tool IDs and names, user IDs, and errors.

searchUserIdsstring

Add exact user ID matches to search. Only applied when search is present.

startedAfterstring date-time

Return runs that started after this UTC timestamp.

status'running' | 'success' | 'failed' | 'aborted'
requestSourcesstring

Filter by request sources (comma-separated for multiple values)

executionKindsstring

Filter by comma-separated execution kinds.

userIdstring

Filter runs by user ID

systemIdstring

Filter runs by system ID

includeTotalboolean

Set to false to skip the exact total count and return a lower-bound total instead.

pageinteger

Page number, starting at 1.

limitinteger

Number of runs to return per page.

Response

List of runs

pageinteger required
limitinteger required
totalinteger required

Exact total unless includeTotal=false, in which case this is a lower bound.

hasMoreboolean required

Example response

{
  "data": [
    {
      "runId": "7f3e9c1a-2b4d-4e8f-9a3b-1c5d7e9f2a4b",
      "toolId": "550e8400-e29b-41d4-a716-446655440000",
      "tool": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "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"
          ]
        },
        "steps": [
          {
            "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
            "config": {
              "url": "https://api.example.com/search",
              "method": "GET",
              "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",
            "dataSelector": "(sourceData) => sourceData.data.items"
          }
        ],
        "outputTransform": "(sourceData) => sourceData.map(item => ({ id: item.id, title: item.name }))",
        "folder": "integrations/payments"
      },
      "status": "success",
      "error": "Connection timeout after 30000 milliseconds",
      "stepResults": [
        {
          "http": {
            "statusCode": 200
          }
        }
      ],
      "requestSource": "api",
      "traceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "resultStorageUri": "s3://superglue-results/org123/runs/7f3e9c1a.json",
      "metadata": {
        "durationMs": 5234
      },
      "fileArtifacts": [
        {
          "fileKey": "report",
          "filename": "monthly_report.csv",
          "contentType": "text/csv",
          "size": 52480,
          "downloadUrl": "https://s3.amazonaws.com/bucket/org/run-files/runId/report.csv?X-Amz-Expires=3600"
        }
      ]
    }
  ],
  "page": 1,
  "limit": 50,
  "total": 327,
  "hasMore": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.