Skip to Content
Playground is live šŸŽ‰ Test up to 9 models at a time against your prompts.Try it out here.
API Reference

API Reference

GET /api/prompts/retrieve

Retrieve a prompt version by slugs and optional tag.

  • Method: GET
  • URL: https://promptstash.app/api/prompts/retrieve
  • Runtime: Edge

Headers

  • x-api-key (required): Your PromptStash API key
  • x-project-slug (required): Project slug
  • x-prompt-slug (required): Prompt slug
  • x-tag (optional): Version tag, defaults to active

Responses

  • 200 OK
{
  "content": "...prompt content...",
  "name": "Version name",
  "version": 3,
  "tags": ["active"]
}
  • 400 Bad Request
{ "ok": false, "error": "Missing required headers" }
  • 401 Unauthorized
{ "ok": false, "error": "Invalid API key" }
  • 404 Not Found
{ "ok": false, "error": "Prompt not found or has no matching versions" }

Example

curl -X GET \
  'https://promptstash.app/api/prompts/retrieve' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'x-project-slug: your-project' \
  -H 'x-prompt-slug: your-prompt' \
  -H 'x-tag: active'
const res = await fetch("https://promptstash.app/api/prompts/retrieve", {
  headers: {
    "x-api-key": process.env.PROMPTSTASH_API_KEY!,
    "x-project-slug": "your-project",
    "x-prompt-slug": "your-prompt",
  },
});
if (!res.ok) throw new Error(await res.text());
const data = await res.json();
Last updated on
Docs homepagePlayground