Retrieve Prompt

GET /prompts/{promptId}

Get a prompt by ID or slug

cURL

curl --request GET \
  --url https://api.portkey.ai/v1/prompts/{promptId} \
  --header 'x-portkey-api-key: <api-key>'

import requests

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

headers = {"x-portkey-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-portkey-api-key': '<api-key>'}};

fetch('https://api.portkey.ai/v1/prompts/{promptId}', 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/{promptId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-portkey-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.portkey.ai/v1/prompts/{promptId}")
  .header("x-portkey-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-portkey-api-key"] = '<api-key>'

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

200

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

Authorizations

x-portkey-api-key · string · header · required

Path Parameters

promptId · string · required

Response

200

application/json

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>