Get Prompt | Humanloop Docs

curl https://api.humanloop.com/v5/prompts/pr_30gco7dx6JDq4200GVOHa \
     -H "X-API-KEY: <apiKey>"

{
  "path": "Personal Projects/Coding Assistant",
  "id": "pr_30gco7dx6JDq4200GVOHa",
  "model": "gpt-4o",
  "name": "Coding Assistant",
  "version_id": "prv_7ZlQREDScH0xkhUwtXruN",
  "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,
  "total_logs_count": 0,
  "inputs": [
    {
      "name": "messages"
    }
  ],
  "endpoint": "chat",
  "template": [
    {
      "content": "You are a helpful coding assistant specialising in {{language}}",
      "role": "system"
    }
  ],
  "provider": "openai",
  "max_tokens": -1,
  "temperature": 0.7,
  "version_name": "coding-assistant-v1",
  "version_description": "Initial version",
  "type": "prompt",
  "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
}

Retrieve the Prompt with the given ID.

By default, the deployed version of the Prompt is returned. Use the query parameters version_id or environment to target a specific version of the Prompt.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Prompt.

Query parameters

version_idstringOptional

A specific Version ID of the Prompt to retrieve.

environmentstringOptional

Name of the Environment to retrieve a deployed Version from.

Response

Successful Response

Errors

422

Get Prompts ID Get Request Unprocessable Entity Error