### Get Directory Source: https://humanloop.com/docs/v5/llms.txt Retrieves information about a specific directory by its path. ```APIDOC ## GET /directories/{path} ### Description Retrieves information about a specific directory. ### Method GET ### Endpoint /directories/{path} ### Parameters #### Path Parameters - **path** (string) - Required - The path to the directory. ### Response #### Success Response (200) - **directory** (object) - The directory object. - **name** (string) - The name of the directory. - **path** (string) - The full path to the directory. - **createdAt** (string) - The timestamp when the directory was created. #### Response Example { "directory": { "name": "data", "path": "/data", "createdAt": "2023-10-27T09:00:00Z" } } ``` -------------------------------- ### Get Prompt Source: https://humanloop.com/docs/v5/llms.txt Retrieves the details of a specific prompt by its ID. ```APIDOC ## GET /prompts/get ### Description Retrieves the details of a specific prompt. ### Method GET ### Endpoint /prompts/get ### Parameters #### Query Parameters - **prompt_id** (string) - Required - The ID of the prompt to retrieve. ``` -------------------------------- ### Call Prompt Source: https://humanloop.com/docs/v5/llms.txt Invokes a prompt with given inputs and returns the model's output. This is a direct way to get a response from a prompt. ```APIDOC ## POST /prompts/call ### Description Invokes a prompt with given inputs and returns the model's output. ### Method POST ### Endpoint /prompts/call ### Parameters #### Request Body - **prompt_id** (string) - Required - The ID of the prompt to call. - **input** (object) - Required - The input for the prompt. - **model_config** (object) - Optional - Configuration for the model call. ``` -------------------------------- ### Call Agent Source: https://humanloop.com/docs/v5/llms.txt Invokes an agent with given inputs and returns the agent's output. This is a direct way to get a response from an agent. ```APIDOC ## POST /agents/call ### Description Invokes an agent with given inputs and returns the agent's output. ### Method POST ### Endpoint /agents/call ### Parameters #### Request Body - **agent_id** (string) - Required - The ID of the agent to call. - **input** (object) - Required - The input for the agent. - **model_config** (object) - Optional - Configuration for the model call. ``` -------------------------------- ### Get Log Source: https://humanloop.com/docs/v5/llms.txt Retrieves a specific log entry by its ID. ```APIDOC ## GET /logs/{logId} ### Description Retrieves a specific log entry by its ID. ### Method GET ### Endpoint /logs/{logId} ### Parameters #### Path Parameters - **logId** (string) - Required - The unique identifier for the log entry. ### Response #### Success Response (200) - **log** (object) - The log object. - **id** (string) - The unique identifier for the log entry. - **timestamp** (string) - The timestamp when the log was created. - **message** (string) - The log message. #### Response Example { "log": { "id": "log_123", "timestamp": "2023-10-27T12:00:00Z", "message": "User logged in." } } ``` -------------------------------- ### Get Agent Source: https://humanloop.com/docs/v5/llms.txt Retrieves the details of a specific agent by its ID. ```APIDOC ## GET /agents/get ### Description Retrieves the details of a specific agent. ### Method GET ### Endpoint /agents/get ### Parameters #### Query Parameters - **agent_id** (string) - Required - The ID of the agent to retrieve. ``` -------------------------------- ### Get Flow Source: https://humanloop.com/docs/v5/llms.txt Retrieves the details of a specific flow by its ID. ```APIDOC ## GET /flows/get ### Description Retrieves the details of a specific flow. ### Method GET ### Endpoint /flows/get ### Parameters #### Query Parameters - **flow_id** (string) - Required - The ID of the flow to retrieve. ``` -------------------------------- ### Project Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for managing projects, including listing, creating, getting, updating, and deleting projects, as well as managing feedback types and exports. ```APIDOC ## GET /projects/list-datasets ### Description Lists datasets for a project. ### Method GET ### Endpoint /projects/list-datasets ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /projects/list ### Description Lists all projects. ### Method GET ### Endpoint /projects/list ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /projects/create ### Description Creates a new project. ### Method POST ### Endpoint /projects/create ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /projects/get ### Description Retrieves a specific project. ### Method GET ### Endpoint /projects/get ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## DELETE /projects/delete ### Description Deletes a project. ### Method DELETE ### Endpoint /projects/delete ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## PUT /projects/update ### Description Updates an existing project. ### Method PUT ### Endpoint /projects/update ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /projects/list-configs ### Description Lists configurations for a project. ### Method GET ### Endpoint /projects/list-configs ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /projects/create-feedback-type ### Description Creates a feedback type for a project. ### Method POST ### Endpoint /projects/create-feedback-type ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## PUT /projects/update-feedback-types ### Description Updates feedback types for a project. ### Method PUT ### Endpoint /projects/update-feedback-types ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /projects/export ### Description Exports data from a project. ### Method POST ### Endpoint /projects/export ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` -------------------------------- ### Continue Agent Call Source: https://humanloop.com/docs/v5/llms.txt Continues a previously started agent call, useful for multi-turn interactions. ```APIDOC ## POST /agents/continue-call ### Description Continues a previously started agent call. ### Method POST ### Endpoint /agents/continue-call ### Parameters #### Request Body - **call_id** (string) - Required - The ID of the agent call to continue. - **input** (object) - Required - The next input in the conversation. ``` -------------------------------- ### Dataset Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for creating, listing, getting, updating, and deleting datasets, as well as managing datapoints within datasets. ```APIDOC ## POST /datasets/create ### Description Creates a new dataset. ### Method POST ### Endpoint /datasets/create ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /datasets/list ### Description Lists all datasets. ### Method GET ### Endpoint /datasets/list ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /datasets/get ### Description Retrieves a specific dataset. ### Method GET ### Endpoint /datasets/get ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## DELETE /datasets/delete ### Description Deletes a dataset. ### Method DELETE ### Endpoint /datasets/delete ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## PUT /datasets/update ### Description Updates an existing dataset. ### Method PUT ### Endpoint /datasets/update ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /datasets/list-datapoints ### Description Lists datapoints within a dataset. ### Method GET ### Endpoint /datasets/list-datapoints ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /datasets/create-datapoint ### Description Creates a datapoint within a dataset. ### Method POST ### Endpoint /datasets/create-datapoint ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` -------------------------------- ### Evaluation Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for managing evaluations, including getting, listing, creating, logging, and updating evaluation statuses. ```APIDOC ## GET /evaluations/get ### Description Retrieves a specific evaluation. ### Method GET ### Endpoint /evaluations/get ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /evaluations/list-datapoints ### Description Lists datapoints associated with an evaluation. ### Method GET ### Endpoint /evaluations/list-datapoints ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /evaluations/create ### Description Creates a new evaluation. ### Method POST ### Endpoint /evaluations/create ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /evaluations/log ### Description Logs an evaluation result. ### Method POST ### Endpoint /evaluations/log ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## PUT /evaluations/result ### Description Updates an evaluation result. ### Method PUT ### Endpoint /evaluations/result ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## PUT /evaluations/update-status ### Description Updates the status of an evaluation. ### Method PUT ### Endpoint /evaluations/update-status ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /evaluations/add-evaluators ### Description Adds evaluators to an evaluation. ### Method POST ### Endpoint /evaluations/add-evaluators ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /evaluations/list ### Description Retrieves a list of evaluations. ### Method GET ### Endpoint /evaluations/list ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` -------------------------------- ### Evaluator Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for listing, creating, getting, deleting, and updating evaluators. ```APIDOC ## GET /evaluators/list ### Description Lists all evaluators. ### Method GET ### Endpoint /evaluators/list ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /evaluators/create ### Description Creates a new evaluator. ### Method POST ### Endpoint /evaluators/create ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## GET /evaluators/get ### Description Retrieves a specific evaluator. ### Method GET ### Endpoint /evaluators/get ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## DELETE /evaluators/delete ### Description Deletes an evaluator. ### Method DELETE ### Endpoint /evaluators/delete ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## PUT /evaluators/update ### Description Updates an existing evaluator. ### Method PUT ### Endpoint /evaluators/update ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` -------------------------------- ### Get Evaluator Source: https://humanloop.com/docs/v5/llms.txt Retrieves the details of a specific evaluator by its ID. ```APIDOC ## GET /evaluators/get ### Description Retrieves the details of a specific evaluator. ### Method GET ### Endpoint /evaluators/get ### Parameters #### Query Parameters - **evaluator_id** (string) - Required - The ID of the evaluator to retrieve. ``` -------------------------------- ### Deploy Prompt Source: https://humanloop.com/docs/v5/llms.txt Sets a specific version of a prompt as the active deployment for a given environment. ```APIDOC ## POST /prompts/set-deployment ### Description Deploys a specific version of a prompt to an environment. ### Method POST ### Endpoint /prompts/set-deployment ### Parameters #### Request Body - **prompt_id** (string) - Required - The ID of the prompt. - **version_id** (string) - Required - The ID of the prompt version to deploy. - **environment** (string) - Required - The environment to deploy to (e.g., 'production', 'staging'). ``` -------------------------------- ### Populate Prompt Template Source: https://humanloop.com/docs/v5/llms.txt Populates a prompt template with given inputs, returning the formatted prompt string. ```APIDOC ## POST /prompts/populate ### Description Populates a prompt template with given inputs. ### Method POST ### Endpoint /prompts/populate ### Parameters #### Request Body - **template** (string) - Required - The prompt template string. - **input** (object) - Required - The input values to populate the template with. ``` -------------------------------- ### Create Directory Source: https://humanloop.com/docs/v5/llms.txt Creates a new directory at the specified path. ```APIDOC ## POST /directories ### Description Creates a new directory. ### Method POST ### Endpoint /directories ### Parameters #### Request Body - **path** (string) - Required - The path for the new directory. ### Request Example { "path": "/new_directory" } ### Response #### Success Response (201) - **message** (string) - A confirmation message. - **directory** (object) - The created directory object. - **name** (string) - The name of the directory. - **path** (string) - The full path to the directory. - **createdAt** (string) - The timestamp when the directory was created. #### Response Example { "message": "Directory created successfully.", "directory": { "name": "new_directory", "path": "/new_directory", "createdAt": "2023-10-27T11:00:00Z" } } ``` -------------------------------- ### List a Prompt's Environments Source: https://humanloop.com/docs/v5/llms.txt Lists all environments where a specific prompt is deployed. ```APIDOC ## GET /prompts/list-environments ### Description Lists all environments where a specific prompt is deployed. ### Method GET ### Endpoint /prompts/list-environments ### Parameters #### Query Parameters - **prompt_id** (string) - Required - The ID of the prompt. ``` -------------------------------- ### List Files Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all files within the project. Supports filtering and pagination. ```APIDOC ## GET /files ### Description Retrieves a list of files. Supports filtering and pagination. ### Method GET ### Endpoint /files ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of files to return. - **offset** (integer) - Optional - The number of files to skip before returning results. - **filter** (string) - Optional - A filter to apply to the file names. ### Response #### Success Response (200) - **files** (array) - A list of file objects. - **name** (string) - The name of the file. - **path** (string) - The full path to the file. - **size** (integer) - The size of the file in bytes. - **createdAt** (string) - The timestamp when the file was created. #### Response Example { "files": [ { "name": "example.txt", "path": "/data/example.txt", "size": 1024, "createdAt": "2023-10-27T10:00:00Z" } ] } ``` -------------------------------- ### Log to a Prompt Source: https://humanloop.com/docs/v5/llms.txt Logs a new entry for a given prompt. This is useful for tracking prompt usage and performance. ```APIDOC ## POST /prompts/log ### Description Logs a new entry for a given prompt. ### Method POST ### Endpoint /prompts/log ### Parameters #### Request Body - **prompt_id** (string) - Required - The ID of the prompt to log. - **input** (object) - Required - The input provided to the prompt. - **output** (object) - Optional - The output generated by the prompt. - **model_config** (object) - Optional - Configuration used for the model call. - **metadata** (object) - Optional - Additional metadata to associate with the log entry. ``` -------------------------------- ### List Prompts Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all prompts available in the project. Supports filtering and pagination. ```APIDOC ## GET /prompts/list ### Description Retrieves a list of all prompts. ### Method GET ### Endpoint /prompts/list ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number for pagination. - **page_size** (integer) - Optional - Number of items per page. - **filter** (string) - Optional - Filter criteria. ``` -------------------------------- ### List Versions of a Prompt Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all version history for a specific prompt. ```APIDOC ## GET /prompts/list-versions ### Description Retrieves a list of all version history for a specific prompt. ### Method GET ### Endpoint /prompts/list-versions ### Parameters #### Query Parameters - **prompt_id** (string) - Required - The ID of the prompt. ``` -------------------------------- ### Deploy Agent Source: https://humanloop.com/docs/v5/llms.txt Sets a specific version of an agent as the active deployment for a given environment. ```APIDOC ## POST /agents/set-deployment ### Description Deploys a specific version of an agent to an environment. ### Method POST ### Endpoint /agents/set-deployment ### Parameters #### Request Body - **agent_id** (string) - Required - The ID of the agent. - **version_id** (string) - Required - The ID of the agent version to deploy. - **environment** (string) - Required - The environment to deploy to (e.g., 'production', 'staging'). ``` -------------------------------- ### List an Agent's Environments Source: https://humanloop.com/docs/v5/llms.txt Lists all environments where a specific agent is deployed. ```APIDOC ## GET /agents/list-environments ### Description Lists all environments where a specific agent is deployed. ### Method GET ### Endpoint /agents/list-environments ### Parameters #### Query Parameters - **agent_id** (string) - Required - The ID of the agent. ``` -------------------------------- ### Deploy Flow Source: https://humanloop.com/docs/v5/llms.txt Sets a specific version of a flow as the active deployment for a given environment. ```APIDOC ## POST /flows/set-deployment ### Description Deploys a specific version of a flow to an environment. ### Method POST ### Endpoint /flows/set-deployment ### Parameters #### Request Body - **flow_id** (string) - Required - The ID of the flow. - **version_id** (string) - Required - The ID of the flow version to deploy. - **environment** (string) - Required - The environment to deploy to (e.g., 'production', 'staging'). ``` -------------------------------- ### Serialize Prompt Source: https://humanloop.com/docs/v5/llms.txt Serializes a prompt into a portable format, useful for backups or migration. ```APIDOC ## POST /prompts/serialize ### Description Serializes a prompt into a portable format. ### Method POST ### Endpoint /prompts/serialize ### Parameters #### Request Body - **prompt_id** (string) - Required - The ID of the prompt to serialize. ``` -------------------------------- ### Deserialize Prompt Source: https://humanloop.com/docs/v5/llms.txt Deserializes a prompt from a portable format, creating or updating a prompt. ```APIDOC ## POST /prompts/deserialize ### Description Deserializes a prompt from a portable format. ### Method POST ### Endpoint /prompts/deserialize ### Parameters #### Request Body - **serialized_data** (string) - Required - The serialized prompt data. ``` -------------------------------- ### List Directories Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all directories. Supports filtering and pagination. ```APIDOC ## GET /directories ### Description Retrieves a list of directories. Supports filtering and pagination. ### Method GET ### Endpoint /directories ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of directories to return. - **offset** (integer) - Optional - The number of directories to skip before returning results. - **filter** (string) - Optional - A filter to apply to the directory names. ### Response #### Success Response (200) - **directories** (array) - A list of directory objects. - **name** (string) - The name of the directory. - **path** (string) - The full path to the directory. - **createdAt** (string) - The timestamp when the directory was created. #### Response Example { "directories": [ { "name": "data", "path": "/data", "createdAt": "2023-10-27T09:00:00Z" } ] } ``` -------------------------------- ### Retrieve File by Path Source: https://humanloop.com/docs/v5/llms.txt Retrieves a specific file by its path. Returns the file content and metadata. ```APIDOC ## GET /files/{path} ### Description Retrieves a specific file by its path. ### Method GET ### Endpoint /files/{path} ### Parameters #### Path Parameters - **path** (string) - Required - The full path to the file. ### Response #### Success Response (200) - **content** (string) - The content of the file. - **name** (string) - The name of the file. - **path** (string) - The full path to the file. - **size** (integer) - The size of the file in bytes. - **createdAt** (string) - The timestamp when the file was created. #### Response Example { "content": "This is the content of the file.", "name": "example.txt", "path": "/data/example.txt", "size": 1024, "createdAt": "2023-10-27T10:00:00Z" } ``` -------------------------------- ### List a Flow's Environments Source: https://humanloop.com/docs/v5/llms.txt Lists all environments where a specific flow is deployed. ```APIDOC ## GET /flows/list-environments ### Description Lists all environments where a specific flow is deployed. ### Method GET ### Endpoint /flows/list-environments ### Parameters #### Query Parameters - **flow_id** (string) - Required - The ID of the flow. ``` -------------------------------- ### List Versions of an Agent Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all version history for a specific agent. ```APIDOC ## GET /agents/list-versions ### Description Retrieves a list of all version history for a specific agent. ### Method GET ### Endpoint /agents/list-versions ### Parameters #### Query Parameters - **agent_id** (string) - Required - The ID of the agent. ``` -------------------------------- ### Log to an Agent Source: https://humanloop.com/docs/v5/llms.txt Logs a new entry for a given agent. This is useful for tracking agent usage and performance. ```APIDOC ## POST /agents/log ### Description Logs a new entry for a given agent. ### Method POST ### Endpoint /agents/log ### Parameters #### Request Body - **agent_id** (string) - Required - The ID of the agent to log. - **input** (object) - Required - The input provided to the agent. - **output** (object) - Optional - The output generated by the agent. - **model_config** (object) - Optional - Configuration used for the model call. - **metadata** (object) - Optional - Additional metadata to associate with the log entry. ``` -------------------------------- ### Move Prompt Source: https://humanloop.com/docs/v5/llms.txt Moves a prompt to a different project or location. ```APIDOC ## POST /prompts/move ### Description Moves a prompt to a different project. ### Method POST ### Endpoint /prompts/move ### Parameters #### Request Body - **prompt_id** (string) - Required - The ID of the prompt to move. - **destination_project_id** (string) - Required - The ID of the destination project. ``` -------------------------------- ### Log to a Flow Source: https://humanloop.com/docs/v5/llms.txt Logs a new entry for a given flow. This is useful for tracking flow usage and performance. ```APIDOC ## POST /flows/log ### Description Logs a new entry for a given flow. ### Method POST ### Endpoint /flows/log ### Parameters #### Request Body - **flow_id** (string) - Required - The ID of the flow to log. - **input** (object) - Required - The input provided to the flow. - **output** (object) - Optional - The output generated by the flow. - **metadata** (object) - Optional - Additional metadata to associate with the log entry. ``` -------------------------------- ### Sessions API Source: https://humanloop.com/docs/v4/llms.txt Endpoints for listing, creating, and retrieving sessions. ```APIDOC ## Sessions API ### Description Endpoints for managing user sessions, including listing, creating, and retrieving session information. ### Endpoints - List Sessions: `/v4/api/sessions/list.md` - Create Session: `/v4/api/sessions/create.md` - Get Session: `/v4/api/sessions/get.md` ``` -------------------------------- ### Update Monitoring Source: https://humanloop.com/docs/v5/llms.txt Updates the monitoring settings for a prompt. ```APIDOC ## POST /prompts/update-monitoring ### Description Updates the monitoring settings for a prompt. ### Method POST ### Endpoint /prompts/update-monitoring ### Parameters #### Request Body - **prompt_id** (string) - Required - The ID of the prompt. - **monitoring_enabled** (boolean) - Required - Whether monitoring is enabled. ``` -------------------------------- ### Completion Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for creating and managing text completions, including deployed completions, model configurations, and experiments. ```APIDOC ## POST /completions/create ### Description Creates a text completion. ### Method POST ### Endpoint /completions/create ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /completions/create-deployed ### Description Creates a deployed text completion. ### Method POST ### Endpoint /completions/create-deployed ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /completions/create-config ### Description Creates a completion model configuration. ### Method POST ### Endpoint /completions/create-config ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /completions/create-experiment ### Description Creates a completion experiment. ### Method POST ### Endpoint /completions/create-experiment ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /completions/create-experiment-stream ### Description Creates a completion experiment with streaming enabled. ### Method POST ### Endpoint /completions/create-experiment-stream ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` -------------------------------- ### List Logs Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of logs. Supports filtering and pagination. ```APIDOC ## GET /logs ### Description Retrieves a list of logs. Supports filtering and pagination. ### Method GET ### Endpoint /logs ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of logs to return. - **offset** (integer) - Optional - The number of logs to skip before returning results. - **filter** (string) - Optional - A filter to apply to the log entries. ### Response #### Success Response (200) - **logs** (array) - A list of log objects. - **id** (string) - The unique identifier for the log entry. - **timestamp** (string) - The timestamp when the log was created. - **message** (string) - The log message. #### Response Example { "logs": [ { "id": "log_123", "timestamp": "2023-10-27T12:00:00Z", "message": "User logged in." } ] } ``` -------------------------------- ### Upsert Prompt Source: https://humanloop.com/docs/v5/llms.txt Creates a new prompt or updates an existing one if it already exists. Useful for managing prompt definitions. ```APIDOC ## POST /prompts/upsert ### Description Creates a new prompt or updates an existing one. ### Method POST ### Endpoint /prompts/upsert ### Parameters #### Request Body - **id** (string) - Optional - The ID of the prompt to upsert. If not provided, a new ID will be generated. - **name** (string) - Required - The name of the prompt. - **template** (string) - Required - The template string for the prompt. - **description** (string) - Optional - A description of the prompt. ``` -------------------------------- ### List Agents Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all agents available in the project. Supports filtering and pagination. ```APIDOC ## GET /agents/list ### Description Retrieves a list of all agents. ### Method GET ### Endpoint /agents/list ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number for pagination. - **page_size** (integer) - Optional - Number of items per page. - **filter** (string) - Optional - Filter criteria. ``` -------------------------------- ### Update Directory Source: https://humanloop.com/docs/v5/llms.txt Updates the path of an existing directory. The directory must be empty. ```APIDOC ## PUT /directories/{path} ### Description Updates the path of an existing directory. The directory must be empty. ### Method PUT ### Endpoint /directories/{path} ### Parameters #### Path Parameters - **path** (string) - Required - The current path of the directory. #### Request Body - **newPath** (string) - Required - The new path for the directory. ### Request Example { "newPath": "/updated_data" } ### Response #### Success Response (200) - **message** (string) - A confirmation message. - **directory** (object) - The updated directory object. - **name** (string) - The name of the directory. - **path** (string) - The full path to the directory. - **createdAt** (string) - The timestamp when the directory was created. #### Response Example { "message": "Directory path updated successfully.", "directory": { "name": "updated_data", "path": "/updated_data", "createdAt": "2023-10-27T09:00:00Z" } } ``` -------------------------------- ### Project Active Config Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for managing the active configuration of a project. ```APIDOC ## GET /projects/active-config/get ### Description Retrieves the active configuration for a project. ### Method GET ### Endpoint /projects/active-config/get ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /projects/active-config/deactivate ### Description Deactivates the active configuration for a project. ### Method POST ### Endpoint /projects/active-config/deactivate ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` -------------------------------- ### Tool API Endpoints Source: https://humanloop.com/docs/v5/llms.txt Endpoints for managing tools, their versions, deployments, environment variables, and monitoring. ```APIDOC ## API > Tools ### Call Tool **Description**: Executes a tool with the given input. **Method**: POST **Endpoint**: /tools/call ### Log to a Tool **Description**: Logs an event or output related to a tool. **Method**: POST **Endpoint**: /tools/log ### Update Tool Log **Description**: Updates an existing tool log entry. **Method**: PUT **Endpoint**: /tools/log/{log_id} ### List Tools **Description**: Retrieves a list of all tools. **Method**: GET **Endpoint**: /tools ### Upsert Tool **Description**: Creates or updates a tool. **Method**: POST **Endpoint**: /tools ### Get Tool **Description**: Retrieves a specific tool. **Method**: GET **Endpoint**: /tools/{tool_id} ### Delete Tool **Description**: Deletes a specific tool. **Method**: DELETE **Endpoint**: /tools/{tool_id} ### Move Tool **Description**: Moves a tool to a different project. **Method**: POST **Endpoint**: /tools/{tool_id}/move ### List Versions of a Tool **Description**: Retrieves a list of all versions for a given tool. **Method**: GET **Endpoint**: /tools/{tool_id}/versions ### Delete Tool Version **Description**: Deletes a specific version of a tool. **Method**: DELETE **Endpoint**: /tools/{tool_id}/versions/{version_id} ### Update Tool Version **Description**: Updates a specific version of a tool. **Method**: PUT **Endpoint**: /tools/{tool_id}/versions/{version_id} ### Deploy Tool **Description**: Deploys a specific version of a tool to an environment. **Method**: POST **Endpoint**: /tools/{tool_id}/versions/{version_id}/deployments ### Remove Deployment **Description**: Removes the deployment of a tool version from an environment. **Method**: DELETE **Endpoint**: /tools/{tool_id}/versions/{version_id}/deployments/{environment_id} ### List a Tool's Environments **Description**: Lists all environments a tool is deployed to. **Method**: GET **Endpoint**: /tools/{tool_id}/environments ### Update Monitoring **Description**: Updates the monitoring settings for a tool. **Method**: PUT **Endpoint**: /tools/{tool_id}/monitoring ### Get Environment Variables **Description**: Retrieves environment variables for a tool. **Method**: GET **Endpoint**: /tools/{tool_id}/environment-variables ### Add Environment Variable **Description**: Adds an environment variable to a tool. **Method**: POST **Endpoint**: /tools/{tool_id}/environment-variables ### Delete Environment Variable **Description**: Deletes an environment variable from a tool. **Method**: DELETE **Endpoint**: /tools/{tool_id}/environment-variables/{variable_name} ``` -------------------------------- ### List Versions of a Flow Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all version history for a specific flow. ```APIDOC ## GET /flows/list-versions ### Description Retrieves a list of all version history for a specific flow. ### Method GET ### Endpoint /flows/list-versions ### Parameters #### Query Parameters - **flow_id** (string) - Required - The ID of the flow. ``` -------------------------------- ### List Flows Source: https://humanloop.com/docs/v5/llms.txt Retrieves a list of all flows available in the project. Supports filtering and pagination. ```APIDOC ## GET /flows/list ### Description Retrieves a list of all flows. ### Method GET ### Endpoint /flows/list ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number for pagination. - **page_size** (integer) - Optional - Number of items per page. - **filter** (string) - Optional - Filter criteria. ``` -------------------------------- ### Model Configs API Source: https://humanloop.com/docs/v4/llms.txt Endpoints for registering, retrieving, exporting, serializing, and deserializing model configurations. ```APIDOC ## Model Configs API ### Description Endpoints for managing model configurations, including registration, retrieval, export, serialization, and deserialization. ### Endpoints - Register Model Config: `/v4/api/model-configs/register.md` - Get Model Config: `/v4/api/model-configs/get.md` - Export Model Config by ID: `/v4/api/model-configs/export.md` - Serialize Model Config: `/v4/api/model-configs/serialize.md` - Deserialize Model Config: `/v4/api/model-configs/deserialize.md` ``` -------------------------------- ### Deserialize Agent Source: https://humanloop.com/docs/v5/llms.txt Deserializes an agent from a portable format, creating or updating an agent. ```APIDOC ## POST /agents/deserialize ### Description Deserializes an agent from a portable format. ### Method POST ### Endpoint /agents/deserialize ### Parameters #### Request Body - **serialized_data** (string) - Required - The serialized agent data. ``` -------------------------------- ### Project Deployed Config Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for managing deployed configurations of a project. ```APIDOC ## GET /projects/deployed-config/list ### Description Lists deployed configurations for a project. ### Method GET ### Endpoint /projects/deployed-config/list ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /projects/deployed-config/deploy ### Description Deploys a configuration for a project. ### Method POST ### Endpoint /projects/deployed-config/deploy ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## DELETE /projects/deployed-config/delete ### Description Deletes a deployed configuration for a project. ### Method DELETE ### Endpoint /projects/deployed-config/delete ### Parameters (Details not provided in source) ### Response (Details not provided in source) ``` -------------------------------- ### Serialize Agent Source: https://humanloop.com/docs/v5/llms.txt Serializes an agent into a portable format, useful for backups or migration. ```APIDOC ## POST /agents/serialize ### Description Serializes an agent into a portable format. ### Method POST ### Endpoint /agents/serialize ### Parameters #### Request Body - **agent_id** (string) - Required - The ID of the agent to serialize. ``` -------------------------------- ### Remove Deployment Source: https://humanloop.com/docs/v5/llms.txt Removes the active deployment of a prompt from a specific environment. ```APIDOC ## POST /prompts/remove-deployment ### Description Removes the active deployment of a prompt from an environment. ### Method POST ### Endpoint /prompts/remove-deployment ### Parameters #### Request Body - **prompt_id** (string) - Required - The ID of the prompt. - **environment** (string) - Required - The environment from which to remove the deployment. ``` -------------------------------- ### Update Prompt Log Source: https://humanloop.com/docs/v5/llms.txt Updates an existing prompt log entry. Allows modification of output, metadata, or other fields. ```APIDOC ## PATCH /prompts/update-log ### Description Updates an existing prompt log entry. ### Method PATCH ### Endpoint /prompts/update-log ### Parameters #### Request Body - **log_id** (string) - Required - The ID of the log entry to update. - **output** (object) - Optional - The updated output. - **metadata** (object) - Optional - Updated metadata. ``` -------------------------------- ### Dataset API Endpoints Source: https://humanloop.com/docs/v5/llms.txt Endpoints for managing datasets, including their versions, deployments, and datapoints. ```APIDOC ## API > Datasets ### List Datasets **Description**: Retrieves a list of all datasets. **Method**: GET **Endpoint**: /datasets ### Upsert Dataset **Description**: Creates or updates a dataset. **Method**: POST **Endpoint**: /datasets ### Get Dataset **Description**: Retrieves a specific dataset. **Method**: GET **Endpoint**: /datasets/{dataset_id} ### Delete Dataset **Description**: Deletes a specific dataset. **Method**: DELETE **Endpoint**: /datasets/{dataset_id} ### Move Dataset **Description**: Moves a dataset to a different project. **Method**: POST **Endpoint**: /datasets/{dataset_id}/move ### List Datapoints **Description**: Retrieves a list of datapoints within a dataset. **Method**: GET **Endpoint**: /datasets/{dataset_id}/datapoints ### List Versions of a Dataset **Description**: Retrieves a list of all versions for a given dataset. **Method**: GET **Endpoint**: /datasets/{dataset_id}/versions ### Delete Dataset Version **Description**: Deletes a specific version of a dataset. **Method**: DELETE **Endpoint**: /datasets/{dataset_id}/versions/{version_id} ### Update Dataset Version **Description**: Updates a specific version of a dataset. **Method**: PUT **Endpoint**: /datasets/{dataset_id}/versions/{version_id} ### Upload CSV **Description**: Uploads a CSV file to create or update a dataset. **Method**: POST **Endpoint**: /datasets/upload-csv ### Deploy Dataset **Description**: Deploys a specific version of a dataset to an environment. **Method**: POST **Endpoint**: /datasets/{dataset_id}/versions/{version_id}/deployments ### Remove Deployment **Description**: Removes the deployment of a dataset version from an environment. **Method**: DELETE **Endpoint**: /datasets/{dataset_id}/versions/{version_id}/deployments/{environment_id} ### List a Dataset's Environments **Description**: Lists all environments a dataset is deployed to. **Method**: GET **Endpoint**: /datasets/{dataset_id}/environments ``` -------------------------------- ### Delete Directory Source: https://humanloop.com/docs/v5/llms.txt Deletes a directory at the specified path. The directory must be empty. ```APIDOC ## DELETE /directories/{path} ### Description Deletes a directory. The directory must be empty. ### Method DELETE ### Endpoint /directories/{path} ### Parameters #### Path Parameters - **path** (string) - Required - The path to the directory to delete. ### Response #### Success Response (200) - **message** (string) - A confirmation message. #### Response Example { "message": "Directory deleted successfully." } ``` -------------------------------- ### Feedback API Source: https://humanloop.com/docs/v4/llms.txt Endpoints for managing feedback within the Humanloop platform. ```APIDOC ## Feedback API ### Description Provides endpoints for managing feedback data. ### Endpoint `/v4/api/feedback/feedback.md` ``` -------------------------------- ### Move Flow Source: https://humanloop.com/docs/v5/llms.txt Moves a flow to a different project or location. ```APIDOC ## POST /flows/move ### Description Moves a flow to a different project. ### Method POST ### Endpoint /flows/move ### Parameters #### Request Body - **flow_id** (string) - Required - The ID of the flow to move. - **destination_project_id** (string) - Required - The ID of the destination project. ``` -------------------------------- ### Move Agent Source: https://humanloop.com/docs/v5/llms.txt Moves an agent to a different project or location. ```APIDOC ## POST /agents/move ### Description Moves an agent to a different project. ### Method POST ### Endpoint /agents/move ### Parameters #### Request Body - **agent_id** (string) - Required - The ID of the agent to move. - **destination_project_id** (string) - Required - The ID of the destination project. ``` -------------------------------- ### Logs API Source: https://humanloop.com/docs/v4/llms.txt Endpoints for listing, retrieving, deleting, and updating logs. ```APIDOC ## Logs API ### Description Endpoints for interacting with log data, including listing, retrieving, deleting, and updating logs. ### Endpoints - List Logs: `/v4/api/logs/list.md` - Get Log: `/v4/api/logs/log.md` - Delete Log: `/v4/api/logs/delete.md` - Update Log by Reference: `/v4/api/logs/update-by-ref.md` - Get Log: `/v4/api/logs/get.md` - Update Log: `/v4/api/logs/update.md` ``` -------------------------------- ### Update Agent Monitoring Source: https://humanloop.com/docs/v5/llms.txt Updates the monitoring settings for an agent. ```APIDOC ## POST /agents/update-monitoring ### Description Updates the monitoring settings for an agent. ### Method POST ### Endpoint /agents/update-monitoring ### Parameters #### Request Body - **agent_id** (string) - Required - The ID of the agent. - **monitoring_enabled** (boolean) - Required - Whether monitoring is enabled. ``` -------------------------------- ### Chat Endpoints Source: https://humanloop.com/docs/v4/llms.txt Endpoints for creating and managing chat interactions, including deployed chats, model configurations, and experiments. ```APIDOC ## POST /chats/create ### Description Creates a new chat interaction. ### Method POST ### Endpoint /chats/create ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /chats/create-deployed ### Description Creates a deployed chat interaction. ### Method POST ### Endpoint /chats/create-deployed ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /chats/create-config ### Description Creates a chat model configuration. ### Method POST ### Endpoint /chats/create-config ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /chats/create-experiment ### Description Creates a chat experiment. ### Method POST ### Endpoint /chats/create-experiment ### Request Body (Details not provided in source) ### Response (Details not provided in source) ``` ```APIDOC ## POST /chats/create-experiment-stream ### Description Creates a chat experiment with streaming enabled. ### Method POST ### Endpoint /chats/create-experiment-stream ### Request Body (Details not provided in source) ### Response (Details not provided in source) ```