Skip to main content
GET
/
sdk
/
v1
/
prompts
/
{id}
JavaScript
import PromptFoundry from '@prompt-foundry/typescript-sdk';

const client = new PromptFoundry({
  apiKey: process.env['PROMPT_FOUNDRY_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const promptConfiguration = await client.prompts.get('1212121');

  console.log(promptConfiguration.id);
}

main();
import os
from prompt_foundry_python_sdk import PromptFoundry

client = PromptFoundry(
# This is the default and can be omitted
api_key=os.environ.get("PROMPT_FOUNDRY_API_KEY"),
)
prompt_configuration = client.prompts.get(
"1212121",
)
print(prompt_configuration.id)
curl --request GET \
--url https://api.promptfoundry.ai/sdk/v1/prompts/{id} \
--header 'X-API-KEY: <api-key>'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.promptfoundry.ai/sdk/v1/prompts/{id}",
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-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.promptfoundry.ai/sdk/v1/prompts/{id}"

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

req.Header.Add("X-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.promptfoundry.ai/sdk/v1/prompts/{id}")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.promptfoundry.ai/sdk/v1/prompts/{id}")

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

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

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "parameters": {
    "name": "<string>",
    "temperature": 123,
    "topP": 123,
    "topK": 2,
    "frequencyPenalty": 123,
    "presencePenalty": 123,
    "maxTokens": 123,
    "seed": 123,
    "toolChoice": "<string>",
    "stream": true,
    "parallelToolCalls": true
  },
  "messages": [
    {
      "content": [
        {
          "type": "TEXT",
          "text": "<string>"
        }
      ]
    }
  ],
  "tools": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "parameters": {}
    }
  ]
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required
Example:

"1212121"

Response

Successful operation

id
string
required

Example: "PROMPT_1"

name
string
required

Example: "Check the weather"

parameters
object
required
messages
object[]
required

The configured messages WITHOUT variables replaced.

tools
object[]
required