agent-swarm.devagent-swarm.dev

Script Connections

Script Connections API endpoints

GET
/api/credential-bindings

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

includeManaged?string
Value in"true" | "false"

Response Body

application/json

curl -X GET "http://localhost:3013/api/credential-bindings"
{
  "bindings": [
    {
      "id": "string",
      "configKey": "string",
      "allowedHosts": [
        "string"
      ],
      "headerTemplate": "string",
      "queryTemplate": "string",
      "scope": "global",
      "scopeId": "string",
      "active": true,
      "authKind": "config",
      "oauthAuthorizationId": "string",
      "source": "default",
      "managedByConnectionId": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "tokenStatus": "ok"
    }
  ]
}
POST
/api/credential-bindings

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/credential-bindings" \  -H "Content-Type: application/json" \  -d '{    "configKey": "string",    "allowedHosts": [      "string"    ]  }'
{
  "binding": {
    "id": "string",
    "configKey": "string",
    "allowedHosts": [
      "string"
    ],
    "headerTemplate": "string",
    "queryTemplate": "string",
    "scope": "global",
    "scopeId": "string",
    "active": true,
    "authKind": "config",
    "oauthAuthorizationId": "string",
    "source": "default",
    "managedByConnectionId": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "tokenStatus": "ok"
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/integrations-catalog

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/integrations-catalog"
{
  "entries": [
    {
      "id": "string",
      "kind": "string",
      "slug": "string",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "domain": "string",
      "categories": [
        "string"
      ],
      "feeds": [
        "string"
      ],
      "vendoredSlug": "string",
      "presetId": "string"
    }
  ],
  "cachedAt": "string",
  "partial": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/integrations-catalog/{domain}/surface

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

domain*string
Match^[a-z0-9.-]+$/i
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/integrations-catalog/string/surface"
{
  "domain": "string",
  "summary": "string",
  "surfaces": [
    {
      "type": "string",
      "name": "string",
      "url": "string",
      "docs": "string",
      "spec": "string",
      "auth": {
        "required": true,
        "credentialIds": [
          "string"
        ],
        "mechanics": {
          "in": "string",
          "headerName": "string",
          "scheme": "string"
        }
      }
    }
  ],
  "credentials": {
    "property1": {
      "type": "string",
      "label": "string",
      "generateUrl": "string",
      "setup": "string"
    },
    "property2": {
      "type": "string",
      "label": "string",
      "generateUrl": "string",
      "setup": "string"
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/oauth-apps

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

curl -X GET "http://localhost:3013/api/oauth-apps"
{
  "oauthApps": [
    {
      "id": "string",
      "provider": "string",
      "clientId": "string",
      "authorizeUrl": "string",
      "tokenUrl": "string",
      "redirectUri": "string",
      "scopes": [
        "string"
      ],
      "extraParams": {
        "property1": "string",
        "property2": "string"
      },
      "tokenAuthStyle": "body",
      "tokenBodyFormat": "form",
      "source": "string",
      "tokenStatus": "ok",
      "expiresAt": "string",
      "lastRefreshedAt": "string",
      "authorizations": [
        {
          "id": "string",
          "label": "string",
          "accountEmail": "string",
          "status": "active",
          "expiresAt": "string",
          "scope": "string",
          "hasRefreshToken": true,
          "lastErrorMessage": "string",
          "lastRefreshedAt": "string",
          "createdAt": "string",
          "updatedAt": "string"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
POST
/api/oauth-apps

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/oauth-apps" \  -H "Content-Type: application/json" \  -d '{    "clientId": "string"  }'
{
  "oauthApp": {
    "id": "string",
    "provider": "string",
    "clientId": "string",
    "authorizeUrl": "string",
    "tokenUrl": "string",
    "redirectUri": "string",
    "scopes": [
      "string"
    ],
    "extraParams": {
      "property1": "string",
      "property2": "string"
    },
    "tokenAuthStyle": "body",
    "tokenBodyFormat": "form",
    "source": "string",
    "tokenStatus": "ok",
    "expiresAt": "string",
    "lastRefreshedAt": "string",
    "authorizations": [
      {
        "id": "string",
        "label": "string",
        "accountEmail": "string",
        "status": "active",
        "expiresAt": "string",
        "scope": "string",
        "hasRefreshToken": true,
        "lastErrorMessage": "string",
        "lastRefreshedAt": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "createdAt": "string",
    "updatedAt": "string"
  },
  "redirectUri": "string",
  "setupHints": [
    "string"
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/oauth-apps/{id}/authorizations

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length <= 255

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/oauth-apps/string/authorizations"
{
  "authorizations": [
    {
      "id": "string",
      "label": "string",
      "accountEmail": "string",
      "status": "active",
      "expiresAt": "string",
      "scope": "string",
      "hasRefreshToken": true,
      "lastErrorMessage": "string",
      "lastRefreshedAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/oauth-apps/{id}/authorize-url

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/oauth-apps/string/authorize-url" \  -H "Content-Type: application/json" \  -d '{}'
{
  "authorizeUrl": "string",
  "state": "string",
  "label": "string",
  "redirectUri": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE
/api/oauth-apps/{provider}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

provider*string
Match^[A-Za-z0-9_-]+$
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/oauth-apps/string"
{
  "success": true,
  "warnings": [
    "string"
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/oauth-apps/{provider}/refresh

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

provider*string
Match^[A-Za-z0-9_-]+$
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/oauth-apps/string/refresh"
{
  "refreshed": true,
  "tokenStatus": "ok",
  "expiresAt": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE
/api/oauth-apps/{provider}/tokens

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

provider*string
Match^[A-Za-z0-9_-]+$
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/oauth-apps/string/tokens"
{
  "disconnected": false,
  "message": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/oauth-apps/discover

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/oauth-apps/discover" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'
{
  "authorizeUrl": "string",
  "tokenUrl": "string",
  "scopes": [
    "string"
  ],
  "sourceUrl": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
DELETE
/api/oauth-authorizations/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:3013/api/oauth-authorizations/string"
{
  "deleted": true,
  "revocationAttempted": true
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/oauth-authorizations/{id}/refresh

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Length1 <= length <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/oauth-authorizations/string/refresh"
{
  "ok": true,
  "status": "active",
  "expiresAt": "string"
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/oauth-presets

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

application/json

curl -X GET "http://localhost:3013/api/oauth-presets"
{
  "presets": [
    {
      "id": "string",
      "displayName": "string",
      "provider": "string",
      "authorizeUrl": "string",
      "tokenUrl": "string",
      "revocationUrl": "string",
      "userinfoUrl": "string",
      "scopes": [
        "string"
      ],
      "scopeSeparator": "string",
      "tokenAuthStyle": "body",
      "tokenBodyFormat": "form",
      "requiresRefreshTokenRotation": true,
      "extraParams": {
        "property1": "string",
        "property2": "string"
      },
      "setupHints": [
        "string"
      ]
    }
  ]
}
GET
/api/script-connections

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

kind?string
Value in"openapi" | "graphql" | "mcp"
scope?string
Value in"global" | "agent" | "repo"
scopeId?string

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/script-connections"
{
  "connections": [
    {
      "id": "string",
      "slug": "string",
      "displayName": "string",
      "kind": "raw",
      "scope": "global",
      "scopeId": "string",
      "baseUrl": "string",
      "baseUrlSource": "user",
      "baseUrlMismatch": {
        "specUrl": "string",
        "effectiveUrl": "string"
      },
      "allowedHosts": [
        "string"
      ],
      "credentialBindingId": "string",
      "authType": "none",
      "authConfigKey": "string",
      "authAuthorizationId": "string",
      "authParamName": "string",
      "authTemplateOverride": "string",
      "authHostsOverride": [
        "string"
      ],
      "openapiSpecSourceKind": "url",
      "openapiSpecSource": "string",
      "openapiSpecEtag": "string",
      "openapiSpecFetchedAt": "string",
      "mcpServerId": "string",
      "generatedAt": "string",
      "generationError": "string",
      "enabled": true,
      "version": 0,
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "operationCount": 0,
      "toolCount": 0,
      "credentialBinding": {
        "id": "string",
        "configKey": "string",
        "authKind": "config",
        "oauthAuthorizationId": "string",
        "tokenStatus": "ok"
      },
      "auth": {
        "type": "none",
        "configKey": "string",
        "authorizationId": "string",
        "paramName": "string",
        "status": "ok"
      }
    }
  ]
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/script-connections

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/script-connections" \  -H "Content-Type: application/json" \  -d '{    "slug": "string",    "kind": "openapi"  }'
{
  "connection": {
    "id": "string",
    "slug": "string",
    "displayName": "string",
    "kind": "raw",
    "scope": "global",
    "scopeId": "string",
    "baseUrl": "string",
    "baseUrlSource": "user",
    "baseUrlMismatch": {
      "specUrl": "string",
      "effectiveUrl": "string"
    },
    "allowedHosts": [
      "string"
    ],
    "credentialBindingId": "string",
    "authType": "none",
    "authConfigKey": "string",
    "authAuthorizationId": "string",
    "authParamName": "string",
    "authTemplateOverride": "string",
    "authHostsOverride": [
      "string"
    ],
    "openapiSpecSourceKind": "url",
    "openapiSpecSource": "string",
    "openapiSpecEtag": "string",
    "openapiSpecFetchedAt": "string",
    "mcpServerId": "string",
    "generatedAt": "string",
    "generationError": "string",
    "enabled": true,
    "version": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "operationCount": 0,
    "toolCount": 0,
    "credentialBinding": {
      "id": "string",
      "configKey": "string",
      "authKind": "config",
      "oauthAuthorizationId": "string",
      "tokenStatus": "ok"
    },
    "auth": {
      "type": "none",
      "configKey": "string",
      "authorizationId": "string",
      "paramName": "string",
      "status": "ok"
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
GET
/api/script-connections/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "http://localhost:3013/api/script-connections/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "connection": {
    "id": "string",
    "slug": "string",
    "displayName": "string",
    "kind": "raw",
    "scope": "global",
    "scopeId": "string",
    "baseUrl": "string",
    "baseUrlSource": "user",
    "baseUrlMismatch": {
      "specUrl": "string",
      "effectiveUrl": "string"
    },
    "allowedHosts": [
      "string"
    ],
    "credentialBindingId": "string",
    "authType": "none",
    "authConfigKey": "string",
    "authAuthorizationId": "string",
    "authParamName": "string",
    "authTemplateOverride": "string",
    "authHostsOverride": [
      "string"
    ],
    "openapiSpecSourceKind": "url",
    "openapiSpecSource": "string",
    "openapiSpecEtag": "string",
    "openapiSpecFetchedAt": "string",
    "mcpServerId": "string",
    "generatedAt": "string",
    "generationError": "string",
    "enabled": true,
    "version": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "operationCount": 0,
    "toolCount": 0,
    "credentialBinding": {
      "id": "string",
      "configKey": "string",
      "authKind": "config",
      "oauthAuthorizationId": "string",
      "tokenStatus": "ok"
    },
    "auth": {
      "type": "none",
      "configKey": "string",
      "authorizationId": "string",
      "paramName": "string",
      "status": "ok"
    },
    "operations": [
      {
        "name": "string",
        "method": "string",
        "path": "string",
        "parameters": [
          {
            "name": "string",
            "in": "string",
            "required": true,
            "schema": null
          }
        ],
        "hasBody": true,
        "successStatus": "string",
        "requestBodySchema": null,
        "responseSchema": null
      }
    ],
    "tools": [
      {
        "name": "string",
        "description": "string",
        "inputSchema": null
      }
    ],
    "graphql": true,
    "generatedTypes": "string",
    "specSummary": {
      "title": "string",
      "version": "string",
      "pathCount": 0
    },
    "specPreview": {
      "json": "string",
      "truncated": true
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/script-connections/{id}/disable

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/script-connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/disable" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'
{
  "connection": {
    "id": "string",
    "slug": "string",
    "displayName": "string",
    "kind": "raw",
    "scope": "global",
    "scopeId": "string",
    "baseUrl": "string",
    "baseUrlSource": "user",
    "baseUrlMismatch": {
      "specUrl": "string",
      "effectiveUrl": "string"
    },
    "allowedHosts": [
      "string"
    ],
    "credentialBindingId": "string",
    "authType": "none",
    "authConfigKey": "string",
    "authAuthorizationId": "string",
    "authParamName": "string",
    "authTemplateOverride": "string",
    "authHostsOverride": [
      "string"
    ],
    "openapiSpecSourceKind": "url",
    "openapiSpecSource": "string",
    "openapiSpecEtag": "string",
    "openapiSpecFetchedAt": "string",
    "mcpServerId": "string",
    "generatedAt": "string",
    "generationError": "string",
    "enabled": true,
    "version": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "operationCount": 0,
    "toolCount": 0,
    "credentialBinding": {
      "id": "string",
      "configKey": "string",
      "authKind": "config",
      "oauthAuthorizationId": "string",
      "tokenStatus": "ok"
    },
    "auth": {
      "type": "none",
      "configKey": "string",
      "authorizationId": "string",
      "paramName": "string",
      "status": "ok"
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/script-connections/{id}/mcp-call

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/script-connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/mcp-call" \  -H "Content-Type: application/json" \  -d '{    "tool": "string"  }'
{
  "ok": true,
  "result": {
    "content": [
      {
        "type": "string",
        "text": "string"
      }
    ],
    "isError": true
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
POST
/api/script-connections/{id}/refresh

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3013/api/script-connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/refresh"
{
  "connection": {
    "id": "string",
    "slug": "string",
    "displayName": "string",
    "kind": "raw",
    "scope": "global",
    "scopeId": "string",
    "baseUrl": "string",
    "baseUrlSource": "user",
    "baseUrlMismatch": {
      "specUrl": "string",
      "effectiveUrl": "string"
    },
    "allowedHosts": [
      "string"
    ],
    "credentialBindingId": "string",
    "authType": "none",
    "authConfigKey": "string",
    "authAuthorizationId": "string",
    "authParamName": "string",
    "authTemplateOverride": "string",
    "authHostsOverride": [
      "string"
    ],
    "openapiSpecSourceKind": "url",
    "openapiSpecSource": "string",
    "openapiSpecEtag": "string",
    "openapiSpecFetchedAt": "string",
    "mcpServerId": "string",
    "generatedAt": "string",
    "generationError": "string",
    "enabled": true,
    "version": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "operationCount": 0,
    "toolCount": 0,
    "credentialBinding": {
      "id": "string",
      "configKey": "string",
      "authKind": "config",
      "oauthAuthorizationId": "string",
      "tokenStatus": "ok"
    },
    "auth": {
      "type": "none",
      "configKey": "string",
      "authorizationId": "string",
      "paramName": "string",
      "status": "ok"
    }
  }
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "property1": null,
  "property2": null
}

Schedules

Create and manage scheduled tasks — run agents on cron expressions or one-time delays

Script Runs

Inspect durable script workflow runs, review journal entries, and monitor swarm-script, raw-LLM, and agent-task execution status through the Script Runs API