Create Prompt

POST /prompts

Create a new prompt

cURL

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": {}
}
'

import requests

url = "https://api.portkey.ai/v1/prompts"

payload = {
    "name": "<string>",
    "collection_id": "<string>",
    "string": "<string>",
    "parameters": {},
    "virtual_key": "<string>",
    "functions": [{}],
    "tools": [{}],
    "tool_choice": {},
    "model": "<string>",
    "version_description": "<string>",
    "template_metadata": {}
}
headers = {
    "x-portkey-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-portkey-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    collection_id: '<string>',
    string: '<string>',
    parameters: {},
    virtual_key: '<string>',
    functions: [{}],
    tools: [{}],
    tool_choice: {},
    model: '<string>',
    version_description: '<string>',
    template_metadata: {}
  })
};

fetch('https://api.portkey.ai/v1/prompts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.portkey.ai/v1/prompts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'collection_id' => '<string>',
    'string' => '<string>',
    'parameters' => [
        
    ],
    'virtual_key' => '<string>',
    'functions' => [
        [
                
        ]
    ],
    'tools' => [
        [
                
        ]
    ],
    'tool_choice' => [
        
    ],
    'model' => '<string>',
    'version_description' => '<string>',
    'template_metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-portkey-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.portkey.ai/v1/prompts"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"string\": \"<string>\",\n  \"parameters\": {},\n  \"virtual_key\": \"<string>\",\n  \"functions\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": {},\n  \"model\": \"<string>\",\n  \"version_description\": \"<string>\",\n  \"template_metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-portkey-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.portkey.ai/v1/prompts")
  .header("x-portkey-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"string\": \"<string>\",\n  \"parameters\": {},\n  \"virtual_key\": \"<string>\",\n  \"functions\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": {},\n  \"model\": \"<string>\",\n  \"version_description\": \"<string>\",\n  \"template_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.portkey.ai/v1/prompts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-portkey-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"collection_id\": \"<string>\",\n  \"string\": \"<string>\",\n  \"parameters\": {},\n  \"virtual_key\": \"<string>\",\n  \"functions\": [\n    {}\n  ],\n  \"tools\": [\n    {}\n  ],\n  \"tool_choice\": {},\n  \"model\": \"<string>\",\n  \"version_description\": \"<string>\",\n  \"template_metadata\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "prompt"
}

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

200

application/json

Prompt created successfully

id · string<uuid>

slug · string

version_id · string<uuid>

object · enum<string>

Available options: prompt