Get the Workflow Tool Catalog

GET

/api/app/{app_slug}/workflow/tool-catalog/

const url = 'https://api.agentaab.com/api/app/example/workflow/tool-catalog/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.agentaab.com/api/app/example/workflow/tool-catalog/ \
  --header 'Authorization: Bearer <token>'

Return built-in and Connection-backed Tool operations available to an authenticated creator for this Workflow. Entries are public-safe execution templates and never contain credential values.

Authorizations

creatorBearerAuth
creatorSessionCookieAuth

Parameters

Path Parameters

app_slug

required

string

Responses

200

The current redacted Workflow Tool Catalog.

application/json

object

catalog

required

Array<object>

Immutable public-safe template for one executable Workflow Tool operation.

object

required

string

revision

required

integer

>= 1

name

required

string

description

required

string

category

required

string

Allowed values: built_in connected mcp

tags

required

Array<string>

featured

required

boolean

execution

required

object

endpoint

required

Exact HTTPS execution endpoint materialized into the v1 Tool binding.

string format: uri

tool_name

required

string

credential_ref

Server-managed reference. It is not a credential value.

string

/^WORKSPACE_CONNECTION_[A-F0-9]{32}$/

credential_mode

string

Allowed values: bearer x_api_key

input_schema

required

Bounded object-root JSON Schema used to generate Inspector controls.

object

key

additional properties

any

defaults

required

object

key

additional properties

any

connection

required

object

required

required

boolean

provider

string

Allowed values: web_search mcp

status

required

string

Allowed values: ready missing attention

risk

required

object

level

required

string

Allowed values: deterministic network external

preview_confirmation

required

boolean

Example

{
  "catalog": [
    {
      "category": "built_in",
      "execution": {
        "credential_mode": "bearer"
      },
      "connection": {
        "provider": "web_search",
        "status": "ready"
      },
      "risk": {
        "level": "deterministic"
      }
    }
  ]
}

401

The creator session is missing, invalid, expired, or does not have a verified email.

application/json

object

error

required

string

code

required

string

Allowed values: creator_session_required creator_email_unverified creator_session_invalid creator_session_expired

Example

{
  "code": "creator_session_required"
}

403

A public Agent Business runtime credential cannot access creator control-plane APIs.

application/json

object

error

required

string

code

required

string

Allowed values: runtime_token_not_allowed

Example

{
  "code": "runtime_token_not_allowed"
}

404

The Workflow is missing or inaccessible.

application/json

object

error

required

string

code

required

string

Allowed values: application_unavailable

Example

{
  "code": "application_unavailable"
}

409

The Agent Business is not a Workflow, or the creator identity conflicts with an existing binding.

application/json

One of:

object
object

object

error

required

string

code

required

string

Allowed values: application_not_workflow

Example

{
  "code": "application_not_workflow"
}

500

An unexpected Workspace Connection failure was sanitized before returning it.

application/json

object

error

required

string

code

required

string

Allowed values: workspace_connection_failed

Example

{
  "code": "workspace_connection_failed"
}

502

The configured creator identity service failed while verifying the session.

application/json

object

error

required

string

code

required

string

Allowed values: creator_session_verification_failed

Example

{
  "code": "creator_session_verification_failed"
}

503

Creator auth, control-plane storage, or authoritative Connection storage is unavailable.

application/json

One of:

object
object

object

error

required

string

code

required

string

Allowed values: creator_auth_provider_invalid creator_session_not_configured creator_control_storage_not_configured

Example

{
  "code": "creator_auth_provider_invalid"
}