Deploy Flow | Humanloop Docs

{
  "path": "Personal Projects/MedQA",
  "id": "fl_6o701g4jmcanPVHxdqD0O",
  "attributes": {
    "prompt": {
      "template": "You are a helpful assistant helping with medical anamnesis",
      "model": "gpt-4o",
      "temperature": 0.8
    },
    "tool": {
      "name": "retrieval_tool_v3",
      "description": "Retrieval tool for MedQA.",
      "source_code": "def retrieval_tool(question: str) -> str:\n    pass\n"
    }
  },
  "name": "MedQA Flow",
  "version_id": "flv_7ZNQREaScH0JkhUwtXrLN",
  "created_at": "2024-07-08T22:40:35.656915",
  "updated_at": "2024-07-08T22:40:35.656915",
  "last_used_at": "2024-07-08T22:40:35.656915",
  "version_logs_count": 0,
  "version_name": "medqa-flow-v1",
  "version_description": "Initial version",
  "type": "flow",
  "environments": [
    {
      "id": "env_ffSVxEBzJcBZ1H5jcNMVj",
      "created_at": "2023-06-27T23:16:07.992339",
      "name": "development",
      "tag": "default"
    }
  ],
  "created_by": {
    "id": "usr_01RJO1k2spBVqNUt1ASef",
    "email_address": "raza@humanloop.com",
    "full_name": "Raza Habib"
  },
  "evaluator_aggregates": null
}

Deploy Flow to an Environment. Set the deployed version for the specified Environment. This Flow will be used for calls made to the Flow in this Environment.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Flow.

environment_idstringRequired

Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstringRequired

Unique identifier for the specific version of the Flow.

Response

Successful Response

pathstring

Path of the Flow, including the name, which is used as a unique identifier.

idstring

Unique identifier for the Flow.

attributesmap from strings to any

A key-value object identifying the Flow Version.

namestring

Name of the Flow.

version_idstring

Unique identifier for the specific Flow Version. If no query params provided, the default deployed Flow Version is returned.

created_atdatetime

updated_atdatetime

last_used_atdatetime

version_logs_countinteger

The number of logs that have been generated for this Flow Version

directory_idstringOptional

ID of the directory that the file is in on Humanloop.

version_namestringOptional

Unique name for the Flow version. Version names must be unique for a given Flow.

version_descriptionstringOptional

Description of the Version.

descriptionstringOptional

Description of the Flow.

schemamap from strings to anyOptional

The JSON schema for the File.

readmestringOptional

Long description of the file.

tagslist of stringsOptional

List of tags associated with the file.

type"flow"Optional

environmentslist of objectsOptional

The list of environments the Flow Version is deployed to.

created_byanyOptional

The user who created the Flow.

evaluator_aggregateslist of objectsOptional

Aggregation of Evaluator results for the Flow Version.

evaluatorslist of objectsOptional

The list of Monitoring Evaluators associated with the Flow Version.

Errors

422

Set Deployment Flows ID Environments Environment ID Post Request Unprocessable Entity Error

$	curl -X POST "https://api.humanloop.com/v5/flows/fl_6o701g4jmcanPVHxdqD0O/environments/staging?version_id=flv_6o701g4jmcanPVHxdqD0O" \
>	-H "X-API-KEY: <apiKey>"