Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
REST API for managing prompts, versions, and deployments
https://api.zeroeval.com
All requests require a Bearer token:
Authorization: Bearer YOUR_ZEROEVAL_API_KEY
GET /v1/prompts/{prompt_slug}
| Query Parameter | Type | Default | Description |
|---|---|---|---|
version | int | — | Fetch a specific version number |
tag | string | "latest" | Tag to fetch ("production", "latest", etc.) |
curl https://api.zeroeval.com/v1/prompts/support-bot \
-H "Authorization: Bearer $ZEROEVAL_API_KEY"
{
"id": "a1b2c3d4-...",
"prompt_id": "b2c3d4e5-...",
"content": "You are a helpful customer support agent.",
"content_hash": "e3b0c44298fc...",
"version": 3,
"model_id": "gpt-4o",
"tag": "production",
"is_latest": true,
"metadata": {},
"created_at": "2025-01-15T10:30:00Z"
}
curl "https://api.zeroeval.com/v1/prompts/support-bot?tag=production" \
-H "Authorization: Bearer $ZEROEVAL_API_KEY"
curl "https://api.zeroeval.com/v1/prompts/support-bot?version=2" \
-H "Authorization: Bearer $ZEROEVAL_API_KEY"
POST /v1/tasks/{task_name}/prompt/versions/ensure
ze.prompt() calls under the hood.
Request body:
| Field | Type | Required | Description |
|---|---|---|---|
content | string | Yes | Prompt content |
content_hash | string | No | SHA-256 hash (computed server-side if omitted) |
model_id | string | No | Model to bind to this version |
metadata | object | No | Additional metadata |
curl -X POST https://api.zeroeval.com/v1/tasks/support-bot/prompt/versions/ensure \
-H "Authorization: Bearer $ZEROEVAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"content": "You are a helpful customer support agent for {{company}}."
}'
{
"id": "c3d4e5f6-...",
"content": "You are a helpful customer support agent for {{company}}.",
"content_hash": "a1b2c3d4...",
"version": 1,
"model_id": null,
"created_at": "2025-01-15T10:30:00Z"
}
GET /v1/tasks/{task_name}/prompt/versions/by-hash/{content_hash}
GET /v1/tasks/{task_name}/prompt/latest
GET /v1/prompt-versions/{version_id}/model
model parameter.
Response: 200
{
"model_id": "gpt-4o",
"provider": "openai"
}
null for model_id if no model is bound.
POST /projects/{project_id}/prompts/{prompt_slug}/tags/{tag}:pin
production) to a specific version number. This is how you deploy a prompt version to production.
Request body:
| Field | Type | Required | Description |
|---|---|---|---|
version | int | Yes | Version number to pin |
curl -X POST https://api.zeroeval.com/projects/$PROJECT_ID/prompts/support-bot/tags/production:pin \
-H "Authorization: Bearer $ZEROEVAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"version": 3}'
GET /projects/{project_id}/prompts/{prompt_slug}/versions
[
{
"id": "c3d4e5f6-...",
"content": "You are a helpful assistant.",
"content_hash": "a1b2c3d4...",
"version": 1,
"model_id": null,
"created_at": "2025-01-10T10:00:00Z"
},
{
"id": "d4e5f6a7-...",
"content": "You are a helpful customer support agent.",
"content_hash": "b2c3d4e5...",
"version": 2,
"model_id": "gpt-4o",
"created_at": "2025-01-15T10:30:00Z"
}
]
GET /projects/{project_id}/prompts/{prompt_slug}/tags
[
{ "tag": "latest", "version": 2 },
{ "tag": "production", "version": 1 }
]
PATCH /projects/{project_id}/prompts/{prompt_slug}/versions/{version}
| Field | Type | Description |
|---|---|---|
model_id | string | Model identifier to bind |
POST /v1/prompts/{prompt_slug}/completions/{completion_id}/feedback
Was this page helpful?