Update Flow Version | Humanloop Docs

curl -X PATCH https://api.humanloop.com/v5/flows/id/versions/version_id \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "path": "path",
  "id": "id",
  "attributes": {
    "key": "value"
  },
  "name": "name",
  "version_id": "version_id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "last_used_at": "2024-01-15T09:30:00Z",
  "version_logs_count": 1,
  "directory_id": "directory_id",
  "version_name": "version_name",
  "version_description": "version_description",
  "description": "description",
  "schema": {
    "key": "value"
  },
  "readme": "readme",
  "tags": [
    "tags"
  ],
  "type": "flow",
  "environments": [
    {
      "id": "id",
      "created_at": "2024-01-15T09:30:00Z",
      "name": "name",
      "tag": "default"
    }
  ],
  "created_by": {
    "id": "id",
    "email_address": "email_address",
    "full_name": "full_name"
  },
  "evaluator_aggregates": [
    {
      "value": 1.1,
      "evaluator_id": "evaluator_id",
      "evaluator_version_id": "evaluator_version_id",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "evaluators": [
    {
      "version_reference": {
        "file": {
          "path": "path",
          "id": "id",
          "model": "model",
          "name": "name",
          "version_id": "version_id",
          "created_at": "2024-01-15T09:30:00Z",
          "updated_at": "2024-01-15T09:30:00Z",
          "last_used_at": "2024-01-15T09:30:00Z",
          "version_logs_count": 1,
          "total_logs_count": 1,
          "inputs": [
            {
              "name": "name"
            }
          ]
        },
        "environment": {
          "id": "id",
          "created_at": "2024-01-15T09:30:00Z",
          "name": "name",
          "tag": "default"
        },
        "type": "environment"
      },
      "state": "active",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "version": {
        "path": "path",
        "id": "id",
        "spec": {
          "arguments_type": "target_free",
          "return_type": "boolean",
          "evaluator_type": "llm"
        },
        "name": "name",
        "version_id": "version_id",
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z",
        "last_used_at": "2024-01-15T09:30:00Z",
        "version_logs_count": 1,
        "total_logs_count": 1,
        "inputs": [
          {
            "name": "name"
          }
        ]
      }
    }
  ]
}

Update the name or description of the Flow version.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Flow.

version_idstringRequired

Unique identifier for the specific version of the Flow.

Request

This endpoint expects an object.

namestringOptional

Name of the version.

descriptionstringOptional

Description of the version.

Response

Successful Response

Errors

422

Update Flow Version Flows ID Versions Version ID Patch Request Unprocessable Entity Error