Skip to main content
GET
/
prompts
/
{promptId}
Get a prompt by ID or slug
curl --request GET \
  --url https://api.portkey.ai/v1/prompts/{promptId} \
  --header 'x-portkey-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "name": "<string>",
  "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "string": "<string>",
  "parameters": {},
  "prompt_version": 123,
  "prompt_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt_version_description": "<string>",
  "prompt_version_label_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "virtual_key": "<string>",
  "model": "<string>",
  "functions": [
    {}
  ],
  "tools": [
    {}
  ],
  "tool_choice": {},
  "template_metadata": {},
  "is_raw_template": true,
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://portkey-docs-migration-04-ai-tools.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-portkey-api-key
string
header
required

Path Parameters

​
promptId
string
required

Response

Prompt details

​
id
string<uuid>
​
slug
string
​
name
string
​
collection_id
string<uuid>
​
string
string
​
parameters
object
​
prompt_version
number
​
prompt_version_id
string<uuid>
​
prompt_version_status
enum<string>
Available options:
active,
archived
​
prompt_version_description
string
​
prompt_version_label_id
string<uuid>
​
virtual_key
string
​
model
string
​
functions
object[]
​
tools
object[]
​
tool_choice
object
​
template_metadata
object
​
is_raw_template
boolean
​
status
string
​
created_at
string<date-time>
​
last_updated_at
string<date-time>