Skip to content

Catalog Endpoints

This is a very custom OpenAPI schema

Overview

Method Endpoint Description
GET /api/v1/catalog/nodes Get Catalog Nodes

API Reference

Custom API - Catalog 1.0.0

This is a very custom OpenAPI schema

Catalog

GET /api/v1/catalog/nodes

Get Catalog Nodes

Description

Return the node and legacy task catalog for workflow authoring.

Input parameters

Parameter In Type Default Nullable Description
HTTPBearer header string N/A No JWT Bearer token

Responses

{
    "catalog_version": 0,
    "schema_hash": "string",
    "nodes": [
        {
            "id": "string",
            "kind": "node",
            "task_type": "string",
            "node_type": null,
            "node_schema_version": 0,
            "implemented": true,
            "workflow_authorable": true,
            "display_name": "string",
            "category": "string",
            "description": "string",
            "providers": null,
            "params_schema": {},
            "io": null,
            "strategies": null
        }
    ],
    "enums": {
        "task_types": [
            "string"
        ],
        "provider_types": [
            "string"
        ],
        "task_statuses": [
            "string"
        ],
        "workflow_statuses": [
            "string"
        ],
        "step_statuses": [
            "string"
        ],
        "transform_types": [
            "string"
        ],
        "provider_to_queue": {}
    }
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
{
    "properties": {
        "catalog_version": {
            "type": "integer",
            "title": "Catalog Version",
            "description": "Catalog contract version."
        },
        "schema_hash": {
            "type": "string",
            "title": "Schema Hash",
            "description": "Deterministic sha256 of the envelope without this field."
        },
        "nodes": {
            "items": {
                "$ref": "#/components/schemas/NodeCatalogCard"
            },
            "type": "array",
            "title": "Nodes",
            "description": "Catalog cards."
        },
        "enums": {
            "$ref": "#/components/schemas/NodeCatalogEnums",
            "description": "Enum values used by catalog clients."
        }
    },
    "additionalProperties": false,
    "type": "object",
    "required": [
        "catalog_version",
        "schema_hash",
        "nodes",
        "enums"
    ],
    "title": "NodeCatalogEnvelope",
    "description": "Top-level node catalog response."
}

Schemas

NodeCatalogCard

Name Type Description
category string UI grouping category.
description string UI description.
display_name string UI display name.
id string Stable card id: node: or task:.
implemented boolean Whether this card maps to implemented execution.
io Workflow I/O JSON Schemas, or null when not workflow-authorable.
kind string Card source.
node_schema_version integer Schema version stamped onto node-authored steps.
node_type Node dispatch key, or null for legacy cards.
params_schema Self-contained task create JSON Schema document.
providers Provider and queue choices for node cards; null for legacy cards.
strategies Strategy choices for nodes that expose strategy selection.
task_type string TaskType enum value.
workflow_authorable boolean True when both workflow input and output schemas resolve.

NodeCatalogEnums

Name Type Description
provider_to_queue
provider_types Array<string>
step_statuses Array<string>
task_statuses Array<string>
task_types Array<string>
transform_types Array<string>
workflow_statuses Array<string>

NodeCatalogEnvelope

Name Type Description
catalog_version integer Catalog contract version.
enums NodeCatalogEnums Enum values used by catalog clients.
nodes Array<NodeCatalogCard> Catalog cards.
schema_hash string Deterministic sha256 of the envelope without this field.

NodeCatalogIO

Name Type Description
inputs Self-contained JSON Schema for workflow inputs.
outputs Self-contained JSON Schema for workflow outputs.

NodeCatalogProvider

Name Type Description
provider_type string ProviderType enum value.
queue string Celery queue used for this provider.

NodeCatalogStrategy

Name Type Description
description string Short strategy behavior summary.
display_name string Human-readable strategy name.
is_default boolean True for the node's default strategy (exactly one per node).
name string Strategy dispatch name accepted by the node.
uses_prompt boolean Whether the strategy reads the task's 'prompt' field. When false, the prompt and fallback_prompts fields are not required and the editor hides them.

Security schemes

Name Type Scheme Description
HTTPBearer http bearer