diff --git a/fern/openapi.json b/fern/openapi.json index 4842e898..81edb48f 100644 --- a/fern/openapi.json +++ b/fern/openapi.json @@ -1530,6 +1530,7 @@ "summary": "Count Sources", "description": "Count all data sources created by a user.", "operationId": "count_sources", + "deprecated": true, "parameters": [], "responses": { "200": { @@ -1562,6 +1563,7 @@ "summary": "Retrieve Source", "description": "Get all sources", "operationId": "retrieve_source", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -1601,6 +1603,7 @@ "summary": "Modify Source", "description": "Update the name or documentation of an existing data source.", "operationId": "modify_source", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -1650,6 +1653,7 @@ "summary": "Delete Source", "description": "Delete a data source.", "operationId": "delete_source", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -1689,6 +1693,7 @@ "summary": "Get Source Id By Name", "description": "Get a source by name", "operationId": "get_source_id_by_name", + "deprecated": true, "parameters": [ { "name": "source_name", @@ -1731,6 +1736,7 @@ "summary": "Get Sources Metadata", "description": "Get aggregated metadata for all sources in an organization.\n\nReturns structured metadata including:\n- Total number of sources\n- Total number of files across all sources\n- Total size of all files\n- Per-source breakdown with file details (file_name, file_size per file) if include_detailed_per_source_metadata is True", "operationId": "get_sources_metadata", + "deprecated": true, "parameters": [ { "name": "include_detailed_per_source_metadata", @@ -1773,6 +1779,7 @@ "summary": "List Sources", "description": "List all data sources created by a user.", "operationId": "list_sources", + "deprecated": true, "parameters": [], "responses": { "200": { @@ -1806,6 +1813,7 @@ "summary": "Create Source", "description": "Create a new data source.", "operationId": "create_source", + "deprecated": true, "parameters": [], "requestBody": { "required": true, @@ -1847,6 +1855,7 @@ "summary": "Upload File To Source", "description": "Upload a file to a data source.", "operationId": "upload_file_to_source", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -1927,6 +1936,7 @@ "summary": "Get Agents For Source", "description": "Get all agent IDs that have the specified source attached.", "operationId": "get_agents_for_source", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -1972,6 +1982,7 @@ "summary": "List Source Passages", "description": "List all passages associated with a data source.", "operationId": "list_source_passages", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -2065,6 +2076,7 @@ "summary": "List Source Files", "description": "List paginated files associated with a data source.", "operationId": "list_source_files", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -2164,6 +2176,7 @@ "summary": "Get File Metadata", "description": "Retrieve metadata for a specific file by its ID.", "operationId": "get_file_metadata", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -2226,6 +2239,7 @@ "summary": "Delete File From Source", "description": "Delete a data source.", "operationId": "delete_file_from_source", + "deprecated": true, "parameters": [ { "name": "source_id", @@ -2425,9 +2439,10 @@ "/v1/folders/name/{folder_name}": { "get": { "tags": ["folders"], - "summary": "Get Folder Id By Name", - "description": "Get a folder by name", - "operationId": "get_folder_id_by_name", + "summary": "Get Folder By Name", + "description": "**Deprecated**: Please use the list endpoint `/GET v1/folders?name=` instead.\n\n\nGet a folder by name.", + "operationId": "get_folder_by_name", + "deprecated": true, "parameters": [ { "name": "folder_name", @@ -2446,7 +2461,7 @@ "application/json": { "schema": { "type": "string", - "title": "Response Get Folder Id By Name" + "title": "Response Get Folder By Name" } } } @@ -2467,9 +2482,9 @@ "/v1/folders/metadata": { "get": { "tags": ["folders"], - "summary": "Get Folders Metadata", + "summary": "Retrieve Metadata", "description": "Get aggregated metadata for all folders in an organization.\n\nReturns structured metadata including:\n- Total number of folders\n- Total number of files across all folders\n- Total size of all files\n- Per-source breakdown with file details (file_name, file_size per file) if include_detailed_per_source_metadata is True", - "operationId": "get_folders_metadata", + "operationId": "retrieve_metadata", "parameters": [ { "name": "include_detailed_per_source_metadata", @@ -2593,6 +2608,24 @@ "title": "Order By" }, "description": "Field to sort by" + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Folder name to filter by", + "title": "Name" + }, + "description": "Folder name to filter by" } ], "responses": { @@ -2745,9 +2778,9 @@ "/v1/folders/{folder_id}/agents": { "get": { "tags": ["folders"], - "summary": "Get Agents For Folder", + "summary": "List Agents For Folder", "description": "Get all agent IDs that have the specified folder attached.", - "operationId": "get_agents_for_folder", + "operationId": "list_agents_for_folder", "parameters": [ { "name": "folder_id", @@ -2757,6 +2790,87 @@ "type": "string", "title": "Folder Id" } + }, + { + "name": "before", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Agent ID cursor for pagination. Returns agents that come before this agent ID in the specified sort order", + "title": "Before" + }, + "description": "Agent ID cursor for pagination. Returns agents that come before this agent ID in the specified sort order" + }, + { + "name": "after", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Agent ID cursor for pagination. Returns agents that come after this agent ID in the specified sort order", + "title": "After" + }, + "description": "Agent ID cursor for pagination. Returns agents that come after this agent ID in the specified sort order" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of agents to return", + "default": 50, + "title": "Limit" + }, + "description": "Maximum number of agents to return" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "enum": ["asc", "desc"], + "type": "string", + "description": "Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first", + "default": "desc", + "title": "Order" + }, + "description": "Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first" + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "const": "created_at", + "type": "string", + "description": "Field to sort by", + "default": "created_at", + "title": "Order By" + }, + "description": "Field to sort by" } ], "responses": { @@ -2769,7 +2883,7 @@ "items": { "type": "string" }, - "title": "Response Get Agents For Folder" + "title": "Response List Agents For Folder" } } } @@ -2803,24 +2917,6 @@ "title": "Folder Id" } }, - { - "name": "after", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Message after which to retrieve the returned messages.", - "title": "After" - }, - "description": "Message after which to retrieve the returned messages." - }, { "name": "before", "in": "query", @@ -2834,22 +2930,73 @@ "type": "null" } ], - "description": "Message before which to retrieve the returned messages.", + "description": "Passage ID cursor for pagination. Returns passages that come before this passage ID in the specified sort order", "title": "Before" }, - "description": "Message before which to retrieve the returned messages." + "description": "Passage ID cursor for pagination. Returns passages that come before this passage ID in the specified sort order" + }, + { + "name": "after", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Passage ID cursor for pagination. Returns passages that come after this passage ID in the specified sort order", + "title": "After" + }, + "description": "Passage ID cursor for pagination. Returns passages that come after this passage ID in the specified sort order" }, { "name": "limit", "in": "query", "required": false, "schema": { - "type": "integer", - "description": "Maximum number of messages to retrieve.", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of passages to return", "default": 100, "title": "Limit" }, - "description": "Maximum number of messages to retrieve." + "description": "Maximum number of passages to return" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "enum": ["asc", "desc"], + "type": "string", + "description": "Sort order for passages by creation time. 'asc' for oldest first, 'desc' for newest first", + "default": "desc", + "title": "Order" + }, + "description": "Sort order for passages by creation time. 'asc' for oldest first, 'desc' for newest first" + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "const": "created_at", + "type": "string", + "description": "Field to sort by", + "default": "created_at", + "title": "Order By" + }, + "description": "Field to sort by" } ], "responses": { @@ -2897,16 +3044,22 @@ } }, { - "name": "limit", + "name": "before", "in": "query", "required": false, "schema": { - "type": "integer", - "description": "Number of files to return", - "default": 1000, - "title": "Limit" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "File ID cursor for pagination. Returns files that come before this file ID in the specified sort order", + "title": "Before" }, - "description": "Number of files to return" + "description": "File ID cursor for pagination. Returns files that come before this file ID in the specified sort order" }, { "name": "after", @@ -2921,10 +3074,55 @@ "type": "null" } ], - "description": "Pagination cursor to fetch the next set of results", + "description": "File ID cursor for pagination. Returns files that come after this file ID in the specified sort order", "title": "After" }, - "description": "Pagination cursor to fetch the next set of results" + "description": "File ID cursor for pagination. Returns files that come after this file ID in the specified sort order" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of files to return", + "default": 1000, + "title": "Limit" + }, + "description": "Maximum number of files to return" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "enum": ["asc", "desc"], + "type": "string", + "description": "Sort order for files by creation time. 'asc' for oldest first, 'desc' for newest first", + "default": "desc", + "title": "Order" + }, + "description": "Sort order for files by creation time. 'asc' for oldest first, 'desc' for newest first" + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "const": "created_at", + "type": "string", + "description": "Field to sort by", + "default": "created_at", + "title": "Order By" + }, + "description": "Field to sort by" }, { "name": "include_content", @@ -3014,7 +3212,7 @@ "get": { "tags": ["agents"], "summary": "List Agents", - "description": "List all agents associated with a given user.\n\nThis endpoint retrieves a list of all agents and their configurations\nassociated with the specified user ID.", + "description": "Get a list of all agents.", "operationId": "list_agents", "parameters": [ { @@ -3347,7 +3545,7 @@ "post": { "tags": ["agents"], "summary": "Create Agent", - "description": "Create a new agent with the specified configuration.", + "description": "Create an agent.", "operationId": "create_agent", "parameters": [ { @@ -3407,7 +3605,7 @@ "get": { "tags": ["agents"], "summary": "Count Agents", - "description": "Get the count of all agents associated with a given user.", + "description": "Get the total number of agents.", "operationId": "count_agents", "parameters": [], "responses": { @@ -3610,7 +3808,7 @@ "patch": { "tags": ["agents"], "summary": "Modify Agent", - "description": "Update an existing agent", + "description": "Update an existing agent.", "operationId": "modify_agent", "parameters": [ { @@ -6365,24 +6563,6 @@ "title": "Group Id" } }, - { - "name": "after", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "Message after which to retrieve the returned messages.", - "title": "After" - }, - "description": "Message after which to retrieve the returned messages." - }, { "name": "before", "in": "query", @@ -6396,22 +6576,73 @@ "type": "null" } ], - "description": "Message before which to retrieve the returned messages.", + "description": "Message ID cursor for pagination. Returns messages that come before this message ID in the specified sort order", "title": "Before" }, - "description": "Message before which to retrieve the returned messages." + "description": "Message ID cursor for pagination. Returns messages that come before this message ID in the specified sort order" + }, + { + "name": "after", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message ID cursor for pagination. Returns messages that come after this message ID in the specified sort order", + "title": "After" + }, + "description": "Message ID cursor for pagination. Returns messages that come after this message ID in the specified sort order" }, { "name": "limit", "in": "query", "required": false, "schema": { - "type": "integer", - "description": "Maximum number of messages to retrieve.", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of messages to retrieve", "default": 10, "title": "Limit" }, - "description": "Maximum number of messages to retrieve." + "description": "Maximum number of messages to retrieve" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "enum": ["asc", "desc"], + "type": "string", + "description": "Sort order for messages by creation time. 'asc' for oldest first, 'desc' for newest first", + "default": "desc", + "title": "Order" + }, + "description": "Sort order for messages by creation time. 'asc' for oldest first, 'desc' for newest first" + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "const": "created_at", + "type": "string", + "description": "Field to sort by", + "default": "created_at", + "title": "Order By" + }, + "description": "Field to sort by" }, { "name": "use_assistant_message", @@ -7190,6 +7421,258 @@ } } }, + "/v1/identities/{identity_id}/agents": { + "get": { + "tags": ["identities"], + "summary": "List Agents For Identity", + "description": "Get all agents associated with the specified identity.", + "operationId": "list_agents_for_identity", + "parameters": [ + { + "name": "identity_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Identity Id" + } + }, + { + "name": "before", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Agent ID cursor for pagination. Returns agents that come before this agent ID in the specified sort order", + "title": "Before" + }, + "description": "Agent ID cursor for pagination. Returns agents that come before this agent ID in the specified sort order" + }, + { + "name": "after", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Agent ID cursor for pagination. Returns agents that come after this agent ID in the specified sort order", + "title": "After" + }, + "description": "Agent ID cursor for pagination. Returns agents that come after this agent ID in the specified sort order" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of agents to return", + "default": 50, + "title": "Limit" + }, + "description": "Maximum number of agents to return" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "enum": ["asc", "desc"], + "type": "string", + "description": "Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first", + "default": "desc", + "title": "Order" + }, + "description": "Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first" + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "const": "created_at", + "type": "string", + "description": "Field to sort by", + "default": "created_at", + "title": "Order By" + }, + "description": "Field to sort by" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgentState" + }, + "title": "Response List Agents For Identity" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/identities/{identity_id}/blocks": { + "get": { + "tags": ["identities"], + "summary": "List Blocks For Identity", + "description": "Get all blocks associated with the specified identity.", + "operationId": "list_blocks_for_identity", + "parameters": [ + { + "name": "identity_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Identity Id" + } + }, + { + "name": "before", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Block ID cursor for pagination. Returns blocks that come before this block ID in the specified sort order", + "title": "Before" + }, + "description": "Block ID cursor for pagination. Returns blocks that come before this block ID in the specified sort order" + }, + { + "name": "after", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Block ID cursor for pagination. Returns blocks that come after this block ID in the specified sort order", + "title": "After" + }, + "description": "Block ID cursor for pagination. Returns blocks that come after this block ID in the specified sort order" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of blocks to return", + "default": 50, + "title": "Limit" + }, + "description": "Maximum number of blocks to return" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "enum": ["asc", "desc"], + "type": "string", + "description": "Sort order for blocks by creation time. 'asc' for oldest first, 'desc' for newest first", + "default": "desc", + "title": "Order" + }, + "description": "Sort order for blocks by creation time. 'asc' for oldest first, 'desc' for newest first" + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "const": "created_at", + "type": "string", + "description": "Field to sort by", + "default": "created_at", + "title": "Order By" + }, + "description": "Field to sort by" + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Block" + }, + "title": "Response List Blocks For Identity" + } + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, "/v1/_internal_templates/groups": { "post": { "tags": ["_internal_templates"], @@ -8078,6 +8561,87 @@ "title": "Block Id" } }, + { + "name": "before", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Agent ID cursor for pagination. Returns agents that come before this agent ID in the specified sort order", + "title": "Before" + }, + "description": "Agent ID cursor for pagination. Returns agents that come before this agent ID in the specified sort order" + }, + { + "name": "after", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Agent ID cursor for pagination. Returns agents that come after this agent ID in the specified sort order", + "title": "After" + }, + "description": "Agent ID cursor for pagination. Returns agents that come after this agent ID in the specified sort order" + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of agents to return", + "default": 50, + "title": "Limit" + }, + "description": "Maximum number of agents to return" + }, + { + "name": "order", + "in": "query", + "required": false, + "schema": { + "enum": ["asc", "desc"], + "type": "string", + "description": "Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first", + "default": "desc", + "title": "Order" + }, + "description": "Sort order for agents by creation time. 'asc' for oldest first, 'desc' for newest first" + }, + { + "name": "order_by", + "in": "query", + "required": false, + "schema": { + "const": "created_at", + "type": "string", + "description": "Field to sort by", + "default": "created_at", + "title": "Order By" + }, + "description": "Field to sort by" + }, { "name": "include_relationships", "in": "query", @@ -10106,10 +10670,30 @@ "type": "null" } ], - "description": "Filter tags by text search", + "description": "Filter tags by text search. Deprecated, please use name field instead", + "deprecated": true, "title": "Query Text" }, - "description": "Filter tags by text search" + "description": "Filter tags by text search. Deprecated, please use name field instead", + "deprecated": true + }, + { + "name": "name", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Filter tags by name", + "title": "Name" + }, + "description": "Filter tags by name" } ], "responses": {