From 4ec897033fc790f85e4253c737aba2f54b1eecc2 Mon Sep 17 00:00:00 2001 From: Josh Rogers Date: Tue, 1 Jul 2025 14:45:30 -0400 Subject: [PATCH] Update LGP api reference docs (#5297) --- docs/docs/cloud/reference/api/openapi.json | 1713 +++++++++++++++----- 1 file changed, 1327 insertions(+), 386 deletions(-) diff --git a/docs/docs/cloud/reference/api/openapi.json b/docs/docs/cloud/reference/api/openapi.json index 782619368..8a3b7f5fc 100644 --- a/docs/docs/cloud/reference/api/openapi.json +++ b/docs/docs/cloud/reference/api/openapi.json @@ -1,6 +1,9 @@ { "openapi": "3.1.0", - "info": { "title": "LangGraph Platform", "version": "0.1.0" }, + "info": { + "title": "LangGraph Platform", + "version": "0.1.0" + }, "tags": [ { "name": "Assistants", @@ -30,14 +33,18 @@ "paths": { "/assistants": { "post": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Create Assistant", "description": "Create an assistant.\n\nAn initial version of the assistant will be created and the assistant is set to that version. To change versions, use the `POST /assistants/{assistant_id}/latest` endpoint.", "operationId": "create_assistant_assistants_post", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AssistantCreate" } + "schema": { + "$ref": "#/components/schemas/AssistantCreate" + } } }, "required": true @@ -47,7 +54,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Assistant" } + "schema": { + "$ref": "#/components/schemas/Assistant" + } } } }, @@ -55,7 +64,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -63,7 +74,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -71,7 +84,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -80,7 +95,9 @@ }, "/assistants/search": { "post": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Search Assistants", "description": "Search for assistants.\n\nThis endpoint also functions as the endpoint to list all assistants.", "operationId": "search_assistants_assistants_search_post", @@ -100,7 +117,9 @@ "content": { "application/json": { "schema": { - "items": { "$ref": "#/components/schemas/Assistant" }, + "items": { + "$ref": "#/components/schemas/Assistant" + }, "type": "array", "title": "Response Search Assistants Assistants Search Post" } @@ -111,7 +130,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -119,7 +140,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -128,7 +151,9 @@ }, "/assistants/{assistant_id}": { "get": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Get Assistant", "description": "Get an assistant by ID.", "operationId": "get_assistant_assistants__assistant_id__get", @@ -151,7 +176,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Assistant" } + "schema": { + "$ref": "#/components/schemas/Assistant" + } } } }, @@ -159,14 +186,18 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "delete": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Delete Assistant", "description": "Delete an assistant by ID.\n\nAll versions of the assistant will be deleted as well.", "operationId": "delete_assistant_assistants__assistant_id__delete", @@ -187,13 +218,19 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -201,14 +238,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "patch": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Patch Assistant", "description": "Update an assistant.", "operationId": "patch_assistant_assistants__assistant_id__patch", @@ -229,7 +270,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AssistantPatch" } + "schema": { + "$ref": "#/components/schemas/AssistantPatch" + } } }, "required": true @@ -239,7 +282,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Assistant" } + "schema": { + "$ref": "#/components/schemas/Assistant" + } } } }, @@ -247,7 +292,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -255,7 +302,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -264,7 +313,9 @@ }, "/assistants/{assistant_id}/graph": { "get": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Get Assistant Graph", "description": "Get an assistant by ID.", "operationId": "get_assistant_graph_assistants__assistant_id__graph_get", @@ -294,7 +345,14 @@ "description": "Include graph representation of subgraphs. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included.", "required": false, "schema": { - "oneOf": [{ "type": "boolean" }, { "type": "integer" }], + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "integer" + } + ], "title": "Xray", "default": false, "description": "Include graph representation of subgraphs. If an integer value is provided, only subgraphs with a depth less than or equal to the value will be included." @@ -310,7 +368,9 @@ "application/json": { "schema": { "additionalProperties": { - "items": { "type": "object" }, + "items": { + "type": "object" + }, "type": "array" }, "type": "object", @@ -323,7 +383,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -331,7 +393,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -340,7 +404,9 @@ }, "/assistants/{assistant_id}/subgraphs": { "get": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Get Assistant Subgraphs", "description": "Get an assistant's subgraphs.", "operationId": "get_assistant_subgraphs_assistants__assistant_id__subgraphs_get", @@ -373,7 +439,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Subgraphs" } + "schema": { + "$ref": "#/components/schemas/Subgraphs" + } } } }, @@ -381,7 +449,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -389,7 +459,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -398,7 +470,9 @@ }, "/assistants/{assistant_id}/subgraphs/{namespace}": { "get": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Get Assistant Subgraphs by Namespace", "description": "Get an assistant's subgraphs filtered by namespace.", "operationId": "get_assistant_subgraphs_assistants__assistant_id__subgraphs__namespace__get", @@ -417,7 +491,10 @@ { "description": "Namespace of the subgraph to filter by.", "required": true, - "schema": { "type": "string", "title": "Namespace" }, + "schema": { + "type": "string", + "title": "Namespace" + }, "name": "namespace", "in": "path" }, @@ -438,7 +515,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Subgraphs" } + "schema": { + "$ref": "#/components/schemas/Subgraphs" + } } } }, @@ -446,7 +525,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -455,7 +536,9 @@ }, "/assistants/{assistant_id}/schemas": { "get": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Get Assistant Schemas", "description": "Get an assistant by ID.", "operationId": "get_assistant_schemas_assistants__assistant_id__schemas_get", @@ -478,7 +561,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/GraphSchema" } + "schema": { + "$ref": "#/components/schemas/GraphSchema" + } } } }, @@ -486,7 +571,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -494,7 +581,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -503,7 +592,9 @@ }, "/assistants/{assistant_id}/versions": { "post": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Get Assistant Versions", "description": "Get all versions of an assistant.", "operationId": "get_assistant_versions_assistants__assistant_id__versions_get", @@ -527,7 +618,9 @@ "content": { "application/json": { "schema": { - "items": { "$ref": "#/components/schemas/Assistant" }, + "items": { + "$ref": "#/components/schemas/Assistant" + }, "type": "array", "title": "Response Search Assistants Assistants Search Post" } @@ -538,7 +631,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -547,7 +642,9 @@ }, "/assistants/{assistant_id}/latest": { "post": { - "tags": ["Assistants"], + "tags": [ + "Assistants" + ], "summary": "Set Latest Assistant Version", "description": "Set the latest version for an assistant.", "operationId": "set_latest_assistant_version_assistants__assistant_id__versions_post", @@ -581,7 +678,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Assistant" } + "schema": { + "$ref": "#/components/schemas/Assistant" + } } } }, @@ -589,7 +688,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -597,7 +698,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -606,14 +709,18 @@ }, "/threads": { "post": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Create Thread", "description": "Create a thread.", "operationId": "create_thread_threads_post", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ThreadCreate" } + "schema": { + "$ref": "#/components/schemas/ThreadCreate" + } } }, "required": true @@ -623,7 +730,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Thread" } + "schema": { + "$ref": "#/components/schemas/Thread" + } } } }, @@ -631,7 +740,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -639,7 +750,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -648,7 +761,9 @@ }, "/threads/search": { "post": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Search Threads", "description": "Search for threads.\n\nThis endpoint also functions as the endpoint to list all threads.", "operationId": "search_threads_threads_search_post", @@ -668,7 +783,9 @@ "content": { "application/json": { "schema": { - "items": { "$ref": "#/components/schemas/Thread" }, + "items": { + "$ref": "#/components/schemas/Thread" + }, "type": "array", "title": "Response Search Threads Threads Search Post" } @@ -679,7 +796,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -688,7 +807,9 @@ }, "/threads/{thread_id}/state": { "get": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Get Thread State", "description": "Get state for a thread.\n\nThe latest state of the thread (i.e. latest checkpoint) is returned.", "operationId": "get_latest_thread_state_threads__thread_id__state_get", @@ -722,7 +843,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ThreadState" } + "schema": { + "$ref": "#/components/schemas/ThreadState" + } } } }, @@ -730,14 +853,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "post": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Update Thread State", "description": "Add state to a thread.", "operationId": "update_thread_state_threads__thread_id__state_post", @@ -758,7 +885,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ThreadStateUpdate" } + "schema": { + "$ref": "#/components/schemas/ThreadStateUpdate" + } } }, "required": true @@ -778,7 +907,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -787,7 +918,9 @@ }, "/threads/{thread_id}/state/{checkpoint_id}": { "get": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Get Thread State At Checkpoint", "description": "Get state for a thread at a specific checkpoint.", "operationId": "get_thread_state_at_checkpoint_threads__thread_id__state__checkpoint_id__get", @@ -833,7 +966,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ThreadState" } + "schema": { + "$ref": "#/components/schemas/ThreadState" + } } } }, @@ -841,7 +976,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -850,7 +987,9 @@ }, "/threads/{thread_id}/state/checkpoint": { "post": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Get Thread State At Checkpoint", "description": "Get state for a thread at a specific checkpoint.", "operationId": "post_thread_state_at_checkpoint_threads__thread_id__state__checkpoint_id__get", @@ -893,7 +1032,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ThreadState" } + "schema": { + "$ref": "#/components/schemas/ThreadState" + } } } }, @@ -901,7 +1042,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -910,7 +1053,9 @@ }, "/threads/{thread_id}/history": { "get": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Get Thread History", "description": "Get all past states for a thread.", "operationId": "get_thread_history_threads__thread_id__history_get", @@ -929,13 +1074,20 @@ }, { "required": false, - "schema": { "type": "integer", "title": "Limit", "default": 10 }, + "schema": { + "type": "integer", + "title": "Limit", + "default": 10 + }, "name": "limit", "in": "query" }, { "required": false, - "schema": { "type": "string", "title": "Before" }, + "schema": { + "type": "string", + "title": "Before" + }, "name": "before", "in": "query" } @@ -959,14 +1111,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "post": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Get Thread History Post", "description": "Get all past states for a thread.", "operationId": "get_thread_history_post_threads__thread_id__history_post", @@ -987,7 +1143,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ThreadStateSearch" } + "schema": { + "$ref": "#/components/schemas/ThreadStateSearch" + } } }, "required": true @@ -1011,7 +1169,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1020,7 +1180,9 @@ }, "/threads/{thread_id}/copy": { "post": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Copy Thread", "description": "Create a new thread with a copy of the state and checkpoints from an existing thread.", "operationId": "copy_thread_post_threads__thread_id__copy_post", @@ -1043,7 +1205,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Thread" } + "schema": { + "$ref": "#/components/schemas/Thread" + } } } }, @@ -1051,7 +1215,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1059,7 +1225,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1068,7 +1236,9 @@ }, "/threads/{thread_id}": { "get": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Get Thread", "description": "Get a thread by ID.", "operationId": "get_thread_threads__thread_id__get", @@ -1091,7 +1261,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Thread" } + "schema": { + "$ref": "#/components/schemas/Thread" + } } } }, @@ -1099,7 +1271,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1107,14 +1281,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "delete": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Delete Thread", "description": "Delete a thread by ID.", "operationId": "delete_thread_threads__thread_id__delete", @@ -1135,13 +1313,19 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1149,14 +1333,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "patch": { - "tags": ["Threads"], + "tags": [ + "Threads" + ], "summary": "Patch Thread", "description": "Update a thread.", "operationId": "patch_thread_threads__thread_id__patch", @@ -1177,7 +1365,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ThreadPatch" } + "schema": { + "$ref": "#/components/schemas/ThreadPatch" + } } }, "required": true @@ -1187,7 +1377,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Thread" } + "schema": { + "$ref": "#/components/schemas/Thread" + } } } }, @@ -1195,7 +1387,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1203,7 +1397,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1212,7 +1408,9 @@ }, "/threads/{thread_id}/runs": { "get": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "List Runs", "description": "List runs for a thread.", "operationId": "list_runs_http_threads__thread_id__runs_get", @@ -1231,13 +1429,21 @@ }, { "required": false, - "schema": { "type": "integer", "title": "Limit", "default": 10 }, + "schema": { + "type": "integer", + "title": "Limit", + "default": 10 + }, "name": "limit", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Offset", "default": 0 }, + "schema": { + "type": "integer", + "title": "Offset", + "default": 0 + }, "name": "offset", "in": "query" }, @@ -1245,7 +1451,13 @@ "required": false, "schema": { "type": "string", - "enum": ["pending", "error", "success", "timeout", "interrupted"] + "enum": [ + "pending", + "error", + "success", + "timeout", + "interrupted" + ] }, "name": "status", "in": "query" @@ -1257,7 +1469,9 @@ "content": { "application/json": { "schema": { - "items": { "$ref": "#/components/schemas/Run" }, + "items": { + "$ref": "#/components/schemas/Run" + }, "type": "array" } } @@ -1267,7 +1481,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1275,14 +1491,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "post": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Create Background Run", "description": "Create a run in existing thread, return the run ID immediately. Don't wait for the final run output.", "operationId": "create_run_threads__thread_id__runs_post", @@ -1303,7 +1523,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/RunCreateStateful" } + "schema": { + "$ref": "#/components/schemas/RunCreateStateful" + } } }, "required": true @@ -1313,7 +1535,17 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Run" } + "schema": { + "$ref": "#/components/schemas/Run" + } + } + }, + "headers": { + "Content-Location": { + "description": "The URL of the run that was created. Can be used to later join the stream.", + "schema": { + "type": "string" + } } } }, @@ -1321,7 +1553,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1329,7 +1563,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1337,7 +1573,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1346,7 +1584,9 @@ }, "/threads/{thread_id}/runs/crons": { "post": { - "tags": ["Crons (Plus tier)"], + "tags": [ + "Crons (Plus tier)" + ], "summary": "Create Thread Cron", "description": "Create a cron to schedule runs on a thread.", "operationId": "create_thread_cron_threads__thread_id__runs_crons_post", @@ -1367,7 +1607,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/CronCreate" } + "schema": { + "$ref": "#/components/schemas/CronCreate" + } } }, "required": true @@ -1377,7 +1619,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Cron" } + "schema": { + "$ref": "#/components/schemas/Cron" + } } } }, @@ -1385,7 +1629,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1393,7 +1639,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1402,7 +1650,9 @@ }, "/threads/{thread_id}/runs/stream": { "post": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Create Run, Stream Output", "description": "Create a run in existing thread. Stream the output.", "operationId": "stream_run_threads__thread_id__runs_stream_post", @@ -1423,7 +1673,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/RunCreateStateful" } + "schema": { + "$ref": "#/components/schemas/RunCreateStateful" + } } }, "required": true @@ -1438,13 +1690,23 @@ "description": "The server will send a stream of events in SSE format.\n\n**Example event**:\n\nid: 1\n\nevent: message\n\ndata: {}" } } + }, + "headers": { + "Content-Location": { + "description": "The URL of the run that was created. Can be used to later join the stream.", + "schema": { + "type": "string" + } + } } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1452,7 +1714,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1460,7 +1724,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1469,7 +1735,9 @@ }, "/threads/{thread_id}/runs/wait": { "post": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Create Run, Wait for Output", "description": "Create a run in existing thread. Wait for the final output and then return it.", "operationId": "wait_run_threads__thread_id__runs_wait_post", @@ -1490,7 +1758,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/RunCreateStateful" } + "schema": { + "$ref": "#/components/schemas/RunCreateStateful" + } } }, "required": true @@ -1498,13 +1768,27 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + }, + "headers": { + "Content-Location": { + "description": "The URL of the run that was created. Can be used to later join the stream.", + "schema": { + "type": "string" + } + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1512,7 +1796,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1520,7 +1806,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1529,7 +1817,9 @@ }, "/threads/{thread_id}/runs/{run_id}": { "get": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Get Run", "description": "Get a run by ID.", "operationId": "get_run_http_threads__thread_id__runs__run_id__get", @@ -1564,7 +1854,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Run" } + "schema": { + "$ref": "#/components/schemas/Run" + } } } }, @@ -1572,7 +1864,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1580,14 +1874,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "delete": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Delete Run", "description": "Delete a run by ID.", "operationId": "delete_run_threads__thread_id__runs__run_id__delete", @@ -1620,13 +1918,19 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1634,7 +1938,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1643,7 +1949,9 @@ }, "/threads/{thread_id}/runs/{run_id}/join": { "get": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Join Run", "description": "Wait for a run to finish.", "operationId": "join_run_http_threads__thread_id__runs__run_id__join_get", @@ -1687,13 +1995,19 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1701,7 +2015,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1710,9 +2026,11 @@ }, "/threads/{thread_id}/runs/{run_id}/stream": { "get": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Join Run Stream", - "description": "Join a run stream. This endpoint streams output in real-time from a run similar to the /threads/__THREAD_ID__/runs/stream endpoint. Only output produced after this endpoint is called will be streamed.", + "description": "Join a run stream. This endpoint streams output in real-time from a run similar to the /threads/__THREAD_ID__/runs/stream endpoint. If the run has been created with `stream_resumable=true`, the stream can be resumed from the last seen event ID.", "operationId": "stream_run_http_threads__thread_id__runs__run_id__join_get", "parameters": [ { @@ -1738,6 +2056,37 @@ }, "name": "run_id", "in": "path" + }, + { + "required": false, + "schema": { + "type": "string", + "title": "Last Event ID", + "description": "The ID of the last event received. Set to -1 if you want to stream all events. Requires `stream_resumable=true` to be set when creating the run." + }, + "name": "Last-Event-ID", + "in": "header" + }, + { + "required": false, + "schema": { + "type": "string", + "title": "Stream Mode", + "description": "The mode to stream the run in. If not provided, the default mode will be used." + }, + "name": "stream_mode", + "in": "query" + }, + { + "required": false, + "schema": { + "type": "boolean", + "title": "Cancel On Disconnect", + "description": "If true, the run will be cancelled if the client disconnects.", + "default": false + }, + "name": "cancel_on_disconnect", + "in": "query" } ], "responses": { @@ -1756,7 +2105,9 @@ "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1764,7 +2115,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1773,7 +2126,9 @@ }, "/threads/{thread_id}/runs/{run_id}/cancel": { "post": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Cancel Run", "operationId": "cancel_run_http_threads__thread_id__runs__run_id__cancel_post", "parameters": [ @@ -1816,7 +2171,10 @@ "required": false, "schema": { "type": "string", - "enum": ["interrupt", "rollback"], + "enum": [ + "interrupt", + "rollback" + ], "title": "Action", "default": "interrupt" }, @@ -1827,13 +2185,19 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1841,7 +2205,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1850,58 +2216,20 @@ }, "/runs/crons": { "post": { - "tags": ["Crons (Plus tier)"], + "tags": [ + "Crons (Plus tier)" + ], "summary": "Create Cron", "description": "Create a cron to schedule runs on new threads.", "operationId": "create_cron_runs_crons_post", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/CronCreate" } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/Cron" } + "schema": { + "$ref": "#/components/schemas/CronCreate" } } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } - } - } - } - } - } - }, - "/runs/crons/search": { - "post": { - "tags": ["Crons (Plus tier)"], - "summary": "Search Crons", - "description": "Search all active crons", - "operationId": "search_crons_runs_crons_post", - "requestBody": { - "content": { - "application/json": { - "schema": { "$ref": "#/components/schemas/CronSearch" } - } - }, "required": true }, "responses": { @@ -1910,7 +2238,61 @@ "content": { "application/json": { "schema": { - "items": { "$ref": "#/components/schemas/Cron" }, + "$ref": "#/components/schemas/Cron" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/runs/crons/search": { + "post": { + "tags": [ + "Crons (Plus tier)" + ], + "summary": "Search Crons", + "description": "Search all active crons", + "operationId": "search_crons_runs_crons_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CronSearch" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/Cron" + }, "type": "array", "title": "Response Search Crons Search Post" } @@ -1921,7 +2303,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1930,7 +2314,9 @@ }, "/runs/stream": { "post": { - "tags": ["Stateless Runs"], + "tags": [ + "Stateless Runs" + ], "summary": "Create Run, Stream Output", "description": "Create a run in a new thread, stream the output.", "operationId": "stream_run_stateless_runs_stream_post", @@ -1954,13 +2340,23 @@ "description": "The server will send a stream of events in SSE format.\n\n**Example event**:\n\nid: 1\n\nevent: message\n\ndata: {}" } } + }, + "headers": { + "Content-Location": { + "description": "The URL of the run that was created. Can be used to later join the stream.", + "schema": { + "type": "string" + } + } } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1968,7 +2364,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -1976,7 +2374,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -1985,7 +2385,9 @@ }, "/runs/cancel": { "post": { - "tags": ["Thread Runs"], + "tags": [ + "Thread Runs" + ], "summary": "Cancel Runs", "description": "Cancel one or more runs. Can cancel runs by thread ID and run IDs, or by status filter.", "operationId": "cancel_runs_post", @@ -1995,7 +2397,10 @@ "required": false, "schema": { "type": "string", - "enum": ["interrupt", "rollback"], + "enum": [ + "interrupt", + "rollback" + ], "title": "Action", "default": "interrupt" }, @@ -2006,18 +2411,24 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/RunsCancel" } + "schema": { + "$ref": "#/components/schemas/RunsCancel" + } } }, "required": true }, "responses": { - "204": { "description": "Success - Runs cancelled" }, + "204": { + "description": "Success - Runs cancelled" + }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2025,7 +2436,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2034,7 +2447,9 @@ }, "/runs/wait": { "post": { - "tags": ["Stateless Runs"], + "tags": [ + "Stateless Runs" + ], "summary": "Create Run, Wait for Output", "description": "Create a run in a new thread. Wait for the final output and then return it.", "operationId": "wait_run_stateless_runs_wait_post", @@ -2051,13 +2466,27 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + }, + "headers": { + "Content-Location": { + "description": "The URL of the run that was created. Can be used to later join the stream.", + "schema": { + "type": "string" + } + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2065,7 +2494,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2073,7 +2504,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2082,7 +2515,9 @@ }, "/runs": { "post": { - "tags": ["Stateless Runs"], + "tags": [ + "Stateless Runs" + ], "summary": "Create Background Run", "description": "Create a run in a new thread, return the run ID immediately. Don't wait for the final run output.", "operationId": "run_stateless_runs_post", @@ -2099,13 +2534,27 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + }, + "headers": { + "Content-Location": { + "description": "The URL of the run that was created. Can be used to later join the stream.", + "schema": { + "type": "string" + } + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2113,7 +2562,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2121,7 +2572,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2130,14 +2583,18 @@ }, "/runs/batch": { "post": { - "tags": ["Stateless Runs"], + "tags": [ + "Stateless Runs" + ], "summary": "Create Run Batch", "description": "Create a batch of runs in new threads, return immediately.", "operationId": "run_batch_stateless_runs_post", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/RunBatchCreate" } + "schema": { + "$ref": "#/components/schemas/RunBatchCreate" + } } }, "required": true @@ -2145,13 +2602,19 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2159,7 +2622,9 @@ "description": "Conflict", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2167,7 +2632,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2176,7 +2643,9 @@ }, "/runs/crons/{cron_id}": { "delete": { - "tags": ["Crons (Plus tier)"], + "tags": [ + "Crons (Plus tier)" + ], "summary": "Delete Cron", "description": "Delete a cron by ID.", "operationId": "delete_cron_runs_crons__cron_id__delete", @@ -2195,13 +2664,19 @@ "responses": { "200": { "description": "Success", - "content": { "application/json": { "schema": {} } } + "content": { + "application/json": { + "schema": {} + } + } }, "404": { "description": "Not Found", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2209,7 +2684,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2218,31 +2695,41 @@ }, "/store/items": { "put": { - "tags": ["Store"], + "tags": [ + "Store" + ], "summary": "Store or update an item.", "operationId": "put_item", "requestBody": { "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/StorePutRequest" } + "schema": { + "$ref": "#/components/schemas/StorePutRequest" + } } } }, "responses": { - "204": { "description": "Success" }, + "204": { + "description": "Success" + }, "422": { "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "delete": { - "tags": ["Store"], + "tags": [ + "Store" + ], "summary": "Delete an item.", "operationId": "delete_item", "requestBody": { @@ -2256,19 +2743,25 @@ } }, "responses": { - "204": { "description": "Success" }, + "204": { + "description": "Success" + }, "422": { "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } } }, "get": { - "tags": ["Store"], + "tags": [ + "Store" + ], "summary": "Retrieve a single item.", "operationId": "get_item", "parameters": [ @@ -2276,13 +2769,20 @@ "name": "key", "in": "query", "required": true, - "schema": { "type": "string" } + "schema": { + "type": "string" + } }, { "name": "namespace", "in": "query", "required": false, - "schema": { "type": "array", "items": { "type": "string" } } + "schema": { + "type": "array", + "items": { + "type": "string" + } + } } ], "responses": { @@ -2290,7 +2790,9 @@ "description": "Success", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Item" } + "schema": { + "$ref": "#/components/schemas/Item" + } } } }, @@ -2298,7 +2800,9 @@ "description": "Bad Request", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -2306,7 +2810,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2315,7 +2821,9 @@ }, "/store/items/search": { "post": { - "tags": ["Store"], + "tags": [ + "Store" + ], "summary": "Search for items within a namespace prefix.", "operationId": "search_items", "requestBody": { @@ -2343,7 +2851,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2352,7 +2862,9 @@ }, "/store/namespaces": { "post": { - "tags": ["Store"], + "tags": [ + "Store" + ], "summary": "List namespaces with optional match conditions.", "operationId": "list_namespaces", "requestBody": { @@ -2380,7 +2892,9 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -2399,7 +2913,9 @@ "required": true, "schema": { "type": "string", - "enum": ["application/json, text/event-stream"] + "enum": [ + "application/json, text/event-stream" + ] }, "description": "Accept header must include both 'application/json' and 'text/event-stream' media types." } @@ -2408,7 +2924,9 @@ "required": true, "content": { "application/json": { - "schema": { "type": "object" }, + "schema": { + "type": "object" + }, "description": "A JSON-RPC 2.0 request, notification, or response object.", "example": { "jsonrpc": "2.0", @@ -2430,7 +2948,11 @@ "200": { "description": "Successful JSON-RPC response.", "content": { - "application/json": { "schema": { "type": "object" } } + "application/json": { + "schema": { + "type": "object" + } + } } }, "202": { @@ -2439,12 +2961,16 @@ "400": { "description": "Bad request: invalid JSON or message format, or unacceptable Accept header." }, - "405": { "description": "HTTP method not allowed." }, + "405": { + "description": "HTTP method not allowed." + }, "500": { "description": "Internal server error or unexpected failure." } }, - "tags": ["MCP"] + "tags": [ + "MCP" + ] }, "get": { "operationId": "get_mcp", @@ -2455,14 +2981,20 @@ "description": "GET method not allowed; streaming not supported." } }, - "tags": ["MCP"] + "tags": [ + "MCP" + ] }, "delete": { "operationId": "delete_mcp", "summary": "Terminate Session", "description": "Implemented according to the Streamable HTTP Transport specification.\nTerminate an MCP session. The server implementation is stateless, so this is a no-op.\n\n", - "responses": { "404": {} }, - "tags": ["MCP"] + "responses": { + "404": {} + }, + "tags": [ + "MCP" + ] } } }, @@ -2484,7 +3016,9 @@ "config": { "properties": { "tags": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Tags" }, @@ -2492,7 +3026,10 @@ "type": "integer", "title": "Recursion Limit" }, - "configurable": { "type": "object", "title": "Configurable" } + "configurable": { + "type": "object", + "title": "Configurable" + } }, "type": "object", "title": "Config", @@ -2526,7 +3063,10 @@ "description": "The name of the assistant" }, "description": { - "type": ["string", "null"], + "type": [ + "string", + "null" + ], "title": "Assistant Description", "description": "The description of the assistant" } @@ -2567,7 +3107,10 @@ }, "if_exists": { "type": "string", - "enum": ["raise", "do_nothing"], + "enum": [ + "raise", + "do_nothing" + ], "title": "If Exists", "description": "How to handle duplicate creation. Must be either 'raise' (raise error if duplicate), or 'do_nothing' (return existing assistant).", "default": "raise" @@ -2578,13 +3121,18 @@ "description": "The name of the assistant. Defaults to 'Untitled'." }, "description": { - "type": ["string", "null"], + "type": [ + "string", + "null" + ], "title": "Description", "description": "The description of the assistant. Defaults to null." } }, "type": "object", - "required": ["graph_id"], + "required": [ + "graph_id" + ], "title": "AssistantCreate", "description": "Payload for creating an assistant." }, @@ -2601,7 +3149,8 @@ "description": "Configuration to use for the graph. Useful when graph is configurable and you want to update the assistant's configuration." }, "metadata": { - "type": "object", "title": "Metadata", + "type": "object", + "title": "Metadata", "description": "Metadata to merge with existing assistant metadata." }, "name": { @@ -2634,12 +3183,20 @@ "Config": { "properties": { "tags": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Tags" }, - "recursion_limit": { "type": "integer", "title": "Recursion Limit" }, - "configurable": { "type": "object", "title": "Configurable" } + "recursion_limit": { + "type": "integer", + "title": "Recursion Limit" + }, + "configurable": { + "type": "object", + "title": "Configurable" + } }, "type": "object", "title": "Config" @@ -2713,7 +3270,6 @@ "title": "End Time", "description": "The end date to stop running the cron." }, - "assistant_id": { "anyOf": [ { @@ -2721,14 +3277,24 @@ "format": "uuid", "title": "Assistant Id" }, - { "type": "string", "title": "Graph Id" } + { + "type": "string", + "title": "Graph Id" + } ], "description": "The assistant ID or graph name to run. If using graph name, will default to the assistant automatically created from that graph by the server." }, "input": { "anyOf": [ - { "items": { "type": "object" }, "type": "array" }, - { "type": "object" } + { + "items": { + "type": "object" + }, + "type": "array" + }, + { + "type": "object" + } ], "title": "Input", "description": "The input to the graph." @@ -2741,7 +3307,9 @@ "config": { "properties": { "tags": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Tags" }, @@ -2749,7 +3317,10 @@ "type": "integer", "title": "Recursion Limit" }, - "configurable": { "type": "object", "title": "Configurable" } + "configurable": { + "type": "object", + "title": "Configurable" + } }, "type": "object", "title": "Config", @@ -2765,30 +3336,58 @@ }, "interrupt_before": { "anyOf": [ - { "type": "string", "enum": ["*"] }, - { "items": { "type": "string" }, "type": "array" } + { + "type": "string", + "enum": [ + "*" + ] + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], "title": "Interrupt Before", "description": "Nodes to interrupt immediately before they get executed." }, "interrupt_after": { "anyOf": [ - { "type": "string", "enum": ["*"] }, - { "items": { "type": "string" }, "type": "array" } + { + "type": "string", + "enum": [ + "*" + ] + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], "title": "Interrupt After", "description": "Nodes to interrupt immediately after they get executed." }, "multitask_strategy": { "type": "string", - "enum": ["reject", "rollback", "interrupt", "enqueue"], + "enum": [ + "reject", + "rollback", + "interrupt", + "enqueue" + ], "title": "Multitask Strategy", "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.", "default": "reject" } }, "type": "object", - "required": ["assistant_id", "schedule"], + "required": [ + "assistant_id", + "schedule" + ], "title": "CronCreate", "description": "Payload for creating a cron job." }, @@ -2823,15 +3422,17 @@ }, "sort_by": { "type": "string", - "enum": ["cron_id", "assistant_id", "thread_id", "next_run_date", "end_time", "created_at", "updated_at"], "title": "Sort By", - "description": "The field to sort by." + "description": "The field to sort by.", + "default": "created_at", + "enum": ["cron_id", "assistant_id", "thread_id", "next_run_date", "end_time", "created_at", "updated_at"] }, "sort_order": { "type": "string", - "enum": ["asc", "desc"], "title": "Sort Order", - "description": "The order to sort by." + "description": "The order to sort by.", + "default": "desc", + "enum": ["asc", "desc"] } }, "type": "object", @@ -2868,7 +3469,11 @@ } }, "type": "object", - "required": ["graph_id", "state_schema", "config_schema"], + "required": [ + "graph_id", + "state_schema", + "config_schema" + ], "title": "GraphSchema", "description": "Defines the structure and properties of a graph." }, @@ -2947,19 +3552,34 @@ }, "status": { "type": "string", - "enum": ["pending", "error", "success", "timeout", "interrupted"], + "enum": [ + "pending", + "running", + "error", + "success", + "timeout", + "interrupted" + ], "title": "Status", - "description": "The status of the run. One of 'pending', 'error', 'success', 'timeout', 'interrupted'." + "description": "The status of the run. One of 'pending', 'running', 'error', 'success', 'timeout', 'interrupted'." }, "metadata": { "type": "object", "title": "Metadata", "description": "The run metadata." }, - "kwargs": { "type": "object", "title": "Kwargs" }, + "kwargs": { + "type": "object", + "title": "Kwargs" + }, "multitask_strategy": { "type": "string", - "enum": ["reject", "rollback", "interrupt", "enqueue"], + "enum": [ + "reject", + "rollback", + "interrupt", + "enqueue" + ], "title": "Multitask Strategy", "description": "Strategy to handle concurrent runs on the same thread." } @@ -2989,12 +3609,22 @@ "description": "The node to send the message to." }, "input": { - "type": ["object", "array", "number", "string", "boolean", "null"], + "type": [ + "object", + "array", + "number", + "string", + "boolean", + "null" + ], "title": "Message", "description": "The message to send." } }, - "required": ["node", "input"] + "required": [ + "node", + "input" + ] }, "Command": { "type": "object", @@ -3002,25 +3632,49 @@ "description": "The command to run.", "properties": { "update": { - "type": ["object", "array", "null"], + "type": [ + "object", + "array", + "null" + ], "title": "Update", "description": "An update to the state." }, "resume": { - "type": ["object", "array", "number", "string", "boolean", "null"], + "type": [ + "object", + "array", + "number", + "string", + "boolean", + "null" + ], "title": "Resume", "description": "A value to pass to an interrupted node." }, "goto": { "anyOf": [ - { "$ref": "#/components/schemas/Send" }, + { + "$ref": "#/components/schemas/Send" + }, { "type": "array", - "items": { "$ref": "#/components/schemas/Send" } + "items": { + "$ref": "#/components/schemas/Send" + } }, - { "type": "string" }, - { "type": "array", "items": { "type": "string" } }, - { "type": "null" } + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } ], "title": "Goto", "description": "Name of the node(s) to navigate to next or node(s) to be executed with a provided input." @@ -3036,7 +3690,10 @@ "format": "uuid", "title": "Assistant Id" }, - { "type": "string", "title": "Graph Id" } + { + "type": "string", + "title": "Graph Id" + } ], "description": "The assistant ID or graph name to run. If using graph name, will default to first assistant created from that graph." }, @@ -3048,20 +3705,36 @@ }, "input": { "anyOf": [ - { "type": "object" }, - { "type": "array" }, - { "type": "string" }, - { "type": "number" }, - { "type": "boolean" }, - { "type": "null" } + { + "type": "object" + }, + { + "type": "array" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } ], "title": "Input", "description": "The input to the graph." }, "command": { "anyOf": [ - { "$ref": "#/components/schemas/Command" }, - { "type": "null" } + { + "$ref": "#/components/schemas/Command" + }, + { + "type": "null" + } ], "title": "Input", "description": "The input to the graph." @@ -3074,7 +3747,9 @@ "config": { "properties": { "tags": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Tags" }, @@ -3082,7 +3757,10 @@ "type": "integer", "title": "Recursion Limit" }, - "configurable": { "type": "object", "title": "Configurable" } + "configurable": { + "type": "object", + "title": "Configurable" + } }, "type": "object", "title": "Config", @@ -3098,16 +3776,36 @@ }, "interrupt_before": { "anyOf": [ - { "type": "string", "enum": ["*"] }, - { "items": { "type": "string" }, "type": "array" } + { + "type": "string", + "enum": [ + "*" + ] + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], "title": "Interrupt Before", "description": "Nodes to interrupt immediately before they get executed." }, "interrupt_after": { "anyOf": [ - { "type": "string", "enum": ["*"] }, - { "items": { "type": "string" }, "type": "array" } + { + "type": "string", + "enum": [ + "*" + ] + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], "title": "Interrupt After", "description": "Nodes to interrupt immediately after they get executed." @@ -3144,7 +3842,9 @@ ], "title": "Stream Mode", "description": "The stream mode(s) to use.", - "default": ["values"] + "default": [ + "values" + ] }, "stream_subgraphs": { "type": "boolean", @@ -3152,35 +3852,54 @@ "description": "Whether to stream output from subgraphs.", "default": false }, + "stream_resumable": { + "type": "boolean", + "title": "Stream Resumable", + "description": "Whether to persist the stream chunks in order to resume the stream later.", + "default": false + }, "on_disconnect": { "type": "string", - "enum": ["cancel", "continue"], + "enum": [ + "cancel", + "continue" + ], "title": "On Disconnect", "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.", "default": "cancel" }, "feedback_keys": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Feedback Keys", "description": "Feedback keys to assign to run." }, "multitask_strategy": { "type": "string", - "enum": ["reject", "rollback", "interrupt", "enqueue"], + "enum": [ + "reject", + "rollback", + "interrupt", + "enqueue" + ], "title": "Multitask Strategy", "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.", "default": "reject" }, "if_not_exists": { "type": "string", - "enum": ["create", "reject"], + "enum": [ + "create", + "reject" + ], "title": "If Not Exists", "description": "How to handle missing thread. Must be either 'reject' (raise error if missing), or 'create' (create new thread).", "default": "reject" }, "after_seconds": { - "type": "integer", + "type": "number", "title": "After Seconds", "description": "The number of seconds to wait before starting the run. Use to schedule future runs." }, @@ -3192,13 +3911,17 @@ } }, "type": "object", - "required": ["assistant_id"], + "required": [ + "assistant_id" + ], "title": "RunCreateStateful", "description": "Payload for creating a run." }, "RunBatchCreate": { "type": "array", - "items": { "$ref": "#/components/schemas/RunCreateStateless" }, + "items": { + "$ref": "#/components/schemas/RunCreateStateless" + }, "minItems": 1, "title": "RunBatchCreate", "description": "Payload for creating a batch of runs." @@ -3212,26 +3935,45 @@ "format": "uuid", "title": "Assistant Id" }, - { "type": "string", "title": "Graph Id" } + { + "type": "string", + "title": "Graph Id" + } ], "description": "The assistant ID or graph name to run. If using graph name, will default to first assistant created from that graph." }, "input": { "anyOf": [ - { "type": "object" }, - { "type": "array" }, - { "type": "string" }, - { "type": "number" }, - { "type": "boolean" }, - { "type": "null" } + { + "type": "object" + }, + { + "type": "array" + }, + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } ], "title": "Input", "description": "The input to the graph." }, "command": { "anyOf": [ - { "$ref": "#/components/schemas/Command" }, - { "type": "null" } + { + "$ref": "#/components/schemas/Command" + }, + { + "type": "null" + } ], "title": "Input", "description": "The input to the graph." @@ -3244,7 +3986,9 @@ "config": { "properties": { "tags": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Tags" }, @@ -3252,7 +3996,10 @@ "type": "integer", "title": "Recursion Limit" }, - "configurable": { "type": "object", "title": "Configurable" } + "configurable": { + "type": "object", + "title": "Configurable" + } }, "type": "object", "title": "Config", @@ -3268,16 +4015,36 @@ }, "interrupt_before": { "anyOf": [ - { "type": "string", "enum": ["*"] }, - { "items": { "type": "string" }, "type": "array" } + { + "type": "string", + "enum": [ + "*" + ] + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], "title": "Interrupt Before", "description": "Nodes to interrupt immediately before they get executed." }, "interrupt_after": { "anyOf": [ - { "type": "string", "enum": ["*"] }, - { "items": { "type": "string" }, "type": "array" } + { + "type": "string", + "enum": [ + "*" + ] + }, + { + "items": { + "type": "string" + }, + "type": "array" + } ], "title": "Interrupt After", "description": "Nodes to interrupt immediately after they get executed." @@ -3314,10 +4081,14 @@ ], "title": "Stream Mode", "description": "The stream mode(s) to use.", - "default": ["values"] + "default": [ + "values" + ] }, "feedback_keys": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Feedback Keys", "description": "Feedback keys to assign to run." @@ -3328,22 +4099,34 @@ "description": "Whether to stream output from subgraphs.", "default": false }, + "stream_resumable": { + "type": "boolean", + "title": "Stream Resumable", + "description": "Whether to persist the stream chunks in order to resume the stream later.", + "default": false + }, "on_completion": { "type": "string", - "enum": ["delete", "keep"], + "enum": [ + "delete", + "keep" + ], "title": "On Completion", "description": "Whether to delete or keep the thread created for a stateless run. Must be one of 'delete' or 'keep'.", "default": "delete" }, "on_disconnect": { "type": "string", - "enum": ["cancel", "continue"], + "enum": [ + "cancel", + "continue" + ], "title": "On Disconnect", "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.", "default": "cancel" }, "after_seconds": { - "type": "integer", + "type": "number", "title": "After Seconds", "description": "The number of seconds to wait before starting the run. Use to schedule future runs." }, @@ -3355,7 +4138,9 @@ } }, "type": "object", - "required": ["assistant_id"], + "required": [ + "assistant_id" + ], "title": "RunCreateStateless", "description": "Payload for creating a run." }, @@ -3400,7 +4185,10 @@ }, "sort_order": { "type": "string", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "title": "Sort Order", "description": "The order to sort by." } @@ -3450,7 +4238,12 @@ }, "status": { "type": "string", - "enum": ["idle", "busy", "interrupted", "error"], + "enum": [ + "idle", + "busy", + "interrupted", + "error" + ], "title": "Status", "description": "Thread status to filter on." }, @@ -3471,13 +4264,21 @@ }, "sort_by": { "type": "string", - "enum": ["thread_id", "status", "created_at", "updated_at"], + "enum": [ + "thread_id", + "status", + "created_at", + "updated_at" + ], "title": "Sort By", "description": "Sort by field." }, "sort_order": { "type": "string", - "enum": ["asc", "desc"], + "enum": [ + "asc", + "desc" + ], "title": "Sort Order", "description": "Sort order." } @@ -3513,7 +4314,12 @@ }, "status": { "type": "string", - "enum": ["idle", "busy", "interrupted", "error"], + "enum": [ + "idle", + "busy", + "interrupted", + "error" + ], "title": "Status", "description": "The status of the thread." }, @@ -3548,7 +4354,10 @@ }, "if_exists": { "type": "string", - "enum": ["raise", "do_nothing"], + "enum": [ + "raise", + "do_nothing" + ], "title": "If Exists", "description": "How to handle duplicate creation. Must be either 'raise' (raise error if duplicate), or 'do_nothing' (return existing thread).", "default": "raise" @@ -3560,7 +4369,9 @@ "properties": { "strategy": { "type": "string", - "enum": ["delete"], + "enum": [ + "delete" + ], "description": "The TTL strategy. 'delete' removes the entire thread.", "default": "delete" }, @@ -3582,7 +4393,9 @@ } } }, - "required": ["updates"] + "required": [ + "updates" + ] } } }, @@ -3615,7 +4428,9 @@ "description": "Include subgraph states." } }, - "required": ["checkpoint"], + "required": [ + "checkpoint" + ], "type": "object", "title": "ThreadStateCheckpointRequest", "description": "Payload for getting the state of a thread at a checkpoint." @@ -3624,13 +4439,22 @@ "properties": { "values": { "anyOf": [ - { "items": { "type": "object" }, "type": "array" }, - { "type": "object" } + { + "items": { + "type": "object" + }, + "type": "array" + }, + { + "type": "object" + } ], "title": "Values" }, "next": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Next" }, @@ -3638,17 +4462,34 @@ "items": { "type": "object", "properties": { - "id": { "type": "string", "title": "Task Id" }, - "name": { "type": "string", "title": "Node Name" }, - "error": { "type": "string", "title": "Error" }, - "interrupts": { "type": "array", "items": {} }, + "id": { + "type": "string", + "title": "Task Id" + }, + "name": { + "type": "string", + "title": "Node Name" + }, + "error": { + "type": "string", + "title": "Error" + }, + "interrupts": { + "type": "array", + "items": {} + }, "checkpoint": { "$ref": "#/components/schemas/CheckpointConfig", "title": "Checkpoint" }, - "state": { "$ref": "#/components/schemas/ThreadState" } + "state": { + "$ref": "#/components/schemas/ThreadState" + } }, - "required": ["id", "name"] + "required": [ + "id", + "name" + ] }, "type": "array", "title": "Tasks" @@ -3657,15 +4498,27 @@ "$ref": "#/components/schemas/CheckpointConfig", "title": "Checkpoint" }, - "metadata": { "type": "object", "title": "Metadata" }, - "created_at": { "type": "string", "title": "Created At" }, + "metadata": { + "type": "object", + "title": "Metadata" + }, + "created_at": { + "type": "string", + "title": "Created At" + }, "parent_checkpoint": { "type": "object", "title": "Parent Checkpoint" } }, "type": "object", - "required": ["values", "next", "checkpoint", "metadata", "created_at"], + "required": [ + "values", + "next", + "checkpoint", + "metadata", + "created_at" + ], "title": "ThreadState" }, "ThreadStateSearch": { @@ -3701,9 +4554,16 @@ "properties": { "values": { "anyOf": [ - { "items": { "type": "object" }, "type": "array" }, - { "type": "object" }, - { "type": "null" } + { + "items": {}, + "type": "array" + }, + { + "type": "object" + }, + { + "type": "null" + } ], "title": "Values", "description": "The values to update the state with." @@ -3727,15 +4587,28 @@ "properties": { "values": { "anyOf": [ - { "type": "array", "items": { "type": "object" } }, - { "type": "object" }, - { "type": "null" } + { + "type": "array", + "items": { + "type": "object" + } + }, + { + "type": "object" + }, + { + "type": "null" + } ] }, "command": { "anyOf": [ - { "$ref": "#/components/schemas/Command" }, - { "type": "null" } + { + "$ref": "#/components/schemas/Command" + }, + { + "type": "null" + } ], "description": "The command associated with the update." }, @@ -3744,12 +4617,17 @@ "description": "Update the state as if this node had just executed." } }, - "required": ["as_node"], + "required": [ + "as_node" + ], "type": "object" }, "ThreadStateUpdateResponse": { "properties": { - "checkpoint": { "type": "object", "title": "Checkpoint" } + "checkpoint": { + "type": "object", + "title": "Checkpoint" + } }, "type": "object", "title": "ThreadStateUpdateResponse", @@ -3780,11 +4658,17 @@ }, "StorePutRequest": { "type": "object", - "required": ["namespace", "key", "value"], + "required": [ + "namespace", + "key", + "value" + ], "properties": { "namespace": { "type": "array", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "title": "Namespace", "description": "A list of strings representing the namespace path." }, @@ -3804,11 +4688,15 @@ }, "StoreDeleteRequest": { "type": "object", - "required": ["key"], + "required": [ + "key" + ], "properties": { "namespace": { "type": "array", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "title": "Namespace", "description": "A list of strings representing the namespace path." }, @@ -3825,25 +4713,25 @@ "type": "object", "properties": { "namespace_prefix": { - "type": ["array", "null"], - "items": { "type": "string" }, + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + }, "title": "Namespace Prefix", "description": "List of strings representing the namespace prefix." }, "filter": { - "type": ["object", "null"], + "type": [ + "object", + "null" + ], "additionalProperties": true, "title": "Filter", "description": "Optional dictionary of key-value pairs to filter results." }, - "query": { - "type": [ - "string", - "null" - ], - "title": "Query", - "description": "Query string for semantic/vector search." - }, "limit": { "type": "integer", "default": 10, @@ -3855,6 +4743,14 @@ "default": 0, "title": "Offset", "description": "Number of items to skip before returning results (default is 0)." + }, + "query": { + "type": [ + "string", + "null" + ], + "title": "Query", + "description": "Query string for semantic/vector search." } }, "title": "StoreSearchRequest", @@ -3865,13 +4761,17 @@ "properties": { "prefix": { "type": "array", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "title": "Prefix", "description": "Optional list of strings representing the prefix to filter namespaces." }, "suffix": { "type": "array", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "title": "Suffix", "description": "Optional list of strings representing the suffix to filter namespaces." }, @@ -3896,11 +4796,19 @@ }, "Item": { "type": "object", - "required": ["namespace", "key", "value", "created_at", "updated_at"], + "required": [ + "namespace", + "key", + "value", + "created_at", + "updated_at" + ], "properties": { "namespace": { "type": "array", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "description": "The namespace of the item. A namespace is analogous to a document's directory." }, "key": { @@ -3931,7 +4839,11 @@ "properties": { "status": { "type": "string", - "enum": ["pending", "running", "all"], + "enum": [ + "pending", + "running", + "all" + ], "title": "Status", "description": "Filter runs by status to cancel. Must be one of 'pending', 'running', or 'all'." }, @@ -3943,29 +4855,50 @@ }, "run_ids": { "type": "array", - "items": { "type": "string", "format": "uuid" }, + "items": { + "type": "string", + "format": "uuid" + }, "title": "Run Ids", "description": "List of run IDs to cancel." } }, "oneOf": [ - { "required": ["status"] }, - { "required": ["thread_id", "run_ids"] } + { + "required": [ + "status" + ] + }, + { + "required": [ + "thread_id", + "run_ids" + ] + } ] }, "SearchItemsResponse": { "type": "object", - "required": ["items"], + "required": [ + "items" + ], "properties": { "items": { "type": "array", - "items": { "$ref": "#/components/schemas/Item" } + "items": { + "$ref": "#/components/schemas/Item" + } } } }, "ListNamespaceResponse": { "type": "array", - "items": { "type": "array", "items": { "type": "string" } } + "items": { + "type": "array", + "items": { + "type": "string" + } + } }, "ErrorResponse": { "type": "string", @@ -3978,7 +4911,9 @@ "description": "Successful retrieval of an item.", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Item" } + "schema": { + "$ref": "#/components/schemas/Item" + } } } }, @@ -3994,7 +4929,9 @@ "description": "Successful search operation.", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/SearchItemsResponse" } + "schema": { + "$ref": "#/components/schemas/SearchItemsResponse" + } } } }, @@ -4002,7 +4939,9 @@ "description": "Successful retrieval of namespaces.", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ListNamespaceResponse" } + "schema": { + "$ref": "#/components/schemas/ListNamespaceResponse" + } } } }, @@ -4010,7 +4949,9 @@ "description": "An error occurred.", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }