api catalog

Browse the operations you can call with api fetch. Without an argument, the command lists every area of the Apps API and Workspace API, with a preview of the operations in each. Pass an area name to list all of its operations. The list comes from the server’s public API spec, so it always matches the API you’re calling. Areas come from the operations’ paths. An app operation belongs to the area named right after the app ID, and any other operation belongs to the one named right after /api. For example, the workflows area holds every operation under /api/apps/{app_id}/workflows. Area names don’t always match the section names in the API reference.

Usage

base44 api catalog [area]

Arguments

Argument	Description	Required
`area`	Omit to list the areas, with a preview of each one’s operations. Pass an area’s name, for example `workflows`, to list that area’s operations instead.	No

Flags

Flag	Description
`--read-only`	List only operations that can’t change anything, the ones `api fetch --read-only` lets through.
`--refresh`	Get the latest list of operations from the server instead of the copy the CLI saved, which it keeps for up to an hour. Use it when an operation that was added recently is missing.

Output

The command returns JSON. Its shape depends on whether you pass an area.

Without an area

The command lists every area. An area with one or two operations lists them under operations. A larger area shows its operationCount and a sample of up to three operation summaries instead:

{
  "areas": [
    {
      "area": "backend-functions",
      "operations": [
        { "endpoint": "DELETE /api/apps/{app_id}/backend-functions/{function_name}", "summary": "Delete a backend function" },
        { "endpoint": "GET /api/apps/{app_id}/backend-functions", "summary": "List backend functions" }
      ]
    },
    {
      "area": "workflows",
      "operationCount": 19,
      "sample": ["List workflows", "List workflow runs for an app", "Get workflow stats"]
    },
    ...
  ],
  "total": 494
}

With an area

The command lists that area’s operations, up to 200. When an area holds more, truncated is true, and total still counts every operation in the area:

{
  "area": "workflows",
  "operations": [
    { "endpoint": "GET /api/apps/{app_id}/workflows", "summary": "List workflows" },
    { "endpoint": "GET /api/apps/{app_id}/workflows/runs", "summary": "List workflow runs for an app" },
    ...
  ],
  "total": 19,
  "truncated": false
}

An area name that doesn’t exist fails with the list of real ones.

Get Started

Commands

Usage

Arguments

Flags

Output

Without an area

With an area

See also

​Usage

​Arguments

​Flags

​Output

​Without an area

​With an area

​See also

Usage

Arguments

Flags

Output

Without an area

With an area

See also