Skip to main content
POST
/
prompts
Create a new prompt
curl --request POST \
  --url https://api.portkey.ai/v1/prompts \
  --header 'Content-Type: application/json' \
  --header 'x-portkey-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "collection_id": "<string>",
  "string": "<string>",
  "parameters": {},
  "virtual_key": "<string>",
  "functions": [
    {}
  ],
  "tools": [
    {}
  ],
  "tool_choice": {},
  "model": "<string>",
  "version_description": "<string>",
  "template_metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

Body

application/json
​
name
string
required
​
collection_id
string
required

UUID or slug of the collection

​
string
string
required

Prompt template in string format

​
parameters
object
required

Parameters for the prompt

​
virtual_key
string
required

The virtual key to use for the prompt

​
functions
object[]

Functions for the prompt

​
tools
object[]

Tools for the prompt

​
tool_choice
object

Tool Choice for the prompt

​
model
string

The model to use for the prompt

​
version_description
string

The description of the prompt version

​
template_metadata
object

Metadata for the prompt

Response

Prompt created successfully

​
id
string<uuid>
​
slug
string
​
version_id
string<uuid>
​
object
enum<string>
Available options:
prompt