Skip to main content
GET
/
v1
/
knowledge-bases
/
{knowledge_base_id}
/
runs
Get Knowledge Base Running Jobs
curl --request GET \
  --url https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/runs \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "created_at": "2023-11-07T05:31:56Z",
    "input": {},
    "output": {},
    "node_ids": [
      "<string>"
    ],
    "single_node_id": "<string>",
    "workflow_definition": {},
    "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "progress": 0,
    "progress_details": {
      "executed_nodes": [
        "<string>"
      ],
      "remaining_nodes": [
        "<string>"
      ],
      "per_node_progress": {},
      "running_nodes": [
        "<string>"
      ],
      "skipped_nodes": [],
      "error_handler_nodes": [],
      "subflow_executions": {},
      "per_edge_progress": {},
      "run_logs": {}
    },
    "definitions": {},
    "started_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "meta": {}
  }
]

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
knowledge_base_id
string
required

Query Parameters

​
status
enum<string> | null
Available options:
queued,
running,
failed,
completed,
stopped,
awaiting_human_feedback
​
run_ids
string | null

Response

Successful Response

​
id
string<uuid>
required
​
group_id
string<uuid>
required
​
workflow_id
string<uuid>
required
​
status
enum<string>
required
Available options:
queued,
running,
failed,
completed,
stopped,
awaiting_human_feedback
​
created_at
string<date-time>
required
​
input
Input · object
​
output
Output · object
​
node_ids
​
single_node_id
string | null
​
workflow_definition
Workflow Definition · object
​
workflow_version_id
string<uuid> | null
​
progress
integer
default:0
​
progress_details
WorkflowProgress · object
​
definitions
Definitions · object
​
started_at
string<date-time> | null
​
finished_at
string<date-time> | null
​
source
string | null
​
meta
Meta · object