Skip to main content
GET
/
workflows
/
v1
/
nodes
Get Nodes
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/nodes \
  --header 'Authorization: Bearer <token>'
{
  "nodes": [
    {
      "team_id": "<string>",
      "created_by": "<string>",
      "updated_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "node_config": {
        "logical_id": "<string>",
        "name": "<string>",
        "primary_category": "System",
        "secondary_category": "LLM",
        "description": "<string>",
        "is_start": false,
        "global_node_config": {
          "is_global": false,
          "condition": {
            "condition_freeform": "<string>",
            "condition_expression": "<string>",
            "args_schema": {},
            "static_messages_config": {
              "static_messages": [
                "<string>"
              ],
              "static_messages_selection_mode": "random"
            }
          }
        },
        "disabled": false,
        "workflow_id": "<string>",
        "miscellaneous": {},
        "main_response_config": {
          "prompt": "<string>"
        },
        "llms_config": {
          "logical_id": "llm_2f4fa4bd-0369-41b3-9d84-e6ff03a7fed2",
          "provider": "default_provider",
          "streaming": false,
          "model_kwargs": {},
          "do_not_split_sentences": false,
          "type": "global_default_llm"
        },
        "tools_config": {
          "tools": [
            {
              "logical_id": "<string>",
              "tool_id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "category": "<string>",
              "signature": "<string>",
              "args_schema": {},
              "static_messages_config": {
                "static_messages": [
                  "<string>"
                ],
                "static_messages_selection_mode": "random"
              },
              "result_runtime_variable_name": "tool_result",
              "type": "inline_python",
              "code": "<string>"
            }
          ]
        },
        "self_loop": false,
        "wait_for_user_message": true,
        "max_consecutive_tool_calls": 1,
        "default_error_message": "I am sorry, there seems to be an issue. Could you please repeat?",
        "type": "worker_llm",
        "structured_output_schema": {},
        "backchannel_response_config": {
          "prompt": "<string>"
        }
      }
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

filters
NodeFilter · object
required
size
integer
default:100

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
search
string | null

Search keywords

start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response

Response model for a list of nodes. Contains a list of NodesModel objects.

nodes
NodesModel · object[]

List of nodes

total
integer | null

Total number of nodes available without pagination.