Deploy Prompt | Humanloop Docs

curl -X POST "https://api.humanloop.com/v5/prompts/id/environments/environment_id?version_id=version_id" \
     -H "X-API-KEY: <apiKey>"

{
  "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"
    }
  ],
  "directory_id": "directory_id",
  "endpoint": "complete",
  "template": "template",
  "template_language": "default",
  "provider": "anthropic",
  "max_tokens": 1,
  "temperature": 1.1,
  "top_p": 1.1,
  "stop": "stop",
  "presence_penalty": 1.1,
  "frequency_penalty": 1.1,
  "other": {
    "key": "value"
  },
  "seed": 1,
  "response_format": {
    "type": "json_object",
    "json_schema": {
      "key": "value"
    }
  },
  "reasoning_effort": "high",
  "tools": [
    {
      "name": "name",
      "description": "description",
      "strict": true,
      "parameters": {
        "key": "value"
      }
    }
  ],
  "linked_tools": [
    {
      "name": "name",
      "description": "description",
      "id": "id",
      "version_id": "version_id",
      "strict": true,
      "parameters": {
        "key": "value"
      }
    }
  ],
  "attributes": {
    "key": "value"
  },
  "version_name": "version_name",
  "version_description": "version_description",
  "description": "description",
  "tags": [
    "tags"
  ],
  "readme": "readme",
  "schema": {
    "key": "value"
  },
  "type": "prompt",
  "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"
    }
  ],
  "raw_file_content": "raw_file_content"
}

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

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Prompt.

environment_idstringRequired

Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstringRequired

Unique identifier for the specific version of the Prompt.

Response

Successful Response

Errors

422

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