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.create({
messages: [
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
promptMessageId: 'promptMessageId',
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
promptMessageId: 'promptMessageId',
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
promptMessageId: 'promptMessageId',
role: 'assistant',
},
],
name: 'name',
parameters: {
frequencyPenalty: 0,
maxTokens: 0,
name: 'name',
parallelToolCalls: true,
presencePenalty: 0,
provider: 'ANTHROPIC',
responseFormat: 'JSON',
seed: 0,
stream: true,
temperature: 0,
toolChoice: 'toolChoice',
topK: 1,
topP: 0,
},
tools: [{ toolId: 'toolId' }, { toolId: 'toolId' }, { toolId: 'toolId' }],
});
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.create(
messages=[{
"content": [{
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}],
"prompt_message_id": "promptMessageId",
"role": "assistant",
}, {
"content": [{
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}],
"prompt_message_id": "promptMessageId",
"role": "assistant",
}, {
"content": [{
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}],
"prompt_message_id": "promptMessageId",
"role": "assistant",
}],
name="name",
parameters={
"frequency_penalty": 0,
"max_tokens": 0,
"name": "name",
"parallel_tool_calls": True,
"presence_penalty": 0,
"provider": "ANTHROPIC",
"response_format": "JSON",
"seed": 0,
"stream": True,
"temperature": 0,
"tool_choice": "toolChoice",
"top_k": 1,
"top_p": 0,
},
tools=[{
"tool_id": "toolId"
}, {
"tool_id": "toolId"
}, {
"tool_id": "toolId"
}],
)
print(prompt_configuration.id)curl --request POST \
--url https://api.promptfoundry.ai/sdk/v1/prompts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"tools": [
{
"toolId": "<string>"
}
],
"messages": [
{
"content": [
{
"type": "TEXT",
"text": "<string>"
}
],
"promptMessageId": "<string>"
}
],
"parameters": {
"name": "<string>",
"temperature": 123,
"topP": 123,
"topK": 2,
"frequencyPenalty": 123,
"presencePenalty": 123,
"maxTokens": 123,
"seed": 123,
"toolChoice": "<string>",
"stream": true,
"parallelToolCalls": true
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.promptfoundry.ai/sdk/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>',
'tools' => [
[
'toolId' => '<string>'
]
],
'messages' => [
[
'content' => [
[
'type' => 'TEXT',
'text' => '<string>'
]
],
'promptMessageId' => '<string>'
]
],
'parameters' => [
'name' => '<string>',
'temperature' => 123,
'topP' => 123,
'topK' => 2,
'frequencyPenalty' => 123,
'presencePenalty' => 123,
'maxTokens' => 123,
'seed' => 123,
'toolChoice' => '<string>',
'stream' => true,
'parallelToolCalls' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.promptfoundry.ai/sdk/v1/prompts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tools\": [\n {\n \"toolId\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n }\n ],\n \"promptMessageId\": \"<string>\"\n }\n ],\n \"parameters\": {\n \"name\": \"<string>\",\n \"temperature\": 123,\n \"topP\": 123,\n \"topK\": 2,\n \"frequencyPenalty\": 123,\n \"presencePenalty\": 123,\n \"maxTokens\": 123,\n \"seed\": 123,\n \"toolChoice\": \"<string>\",\n \"stream\": true,\n \"parallelToolCalls\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.promptfoundry.ai/sdk/v1/prompts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tools\": [\n {\n \"toolId\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n }\n ],\n \"promptMessageId\": \"<string>\"\n }\n ],\n \"parameters\": {\n \"name\": \"<string>\",\n \"temperature\": 123,\n \"topP\": 123,\n \"topK\": 2,\n \"frequencyPenalty\": 123,\n \"presencePenalty\": 123,\n \"maxTokens\": 123,\n \"seed\": 123,\n \"toolChoice\": \"<string>\",\n \"stream\": true,\n \"parallelToolCalls\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.promptfoundry.ai/sdk/v1/prompts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tools\": [\n {\n \"toolId\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n }\n ],\n \"promptMessageId\": \"<string>\"\n }\n ],\n \"parameters\": {\n \"name\": \"<string>\",\n \"temperature\": 123,\n \"topP\": 123,\n \"topK\": 2,\n \"frequencyPenalty\": 123,\n \"presencePenalty\": 123,\n \"maxTokens\": 123,\n \"seed\": 123,\n \"toolChoice\": \"<string>\",\n \"stream\": true,\n \"parallelToolCalls\": true\n }\n}"
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>"
}API Reference
Create Prompt
Creates and deploys a new prompt
POST
/
sdk
/
v1
/
prompts
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.create({
messages: [
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
promptMessageId: 'promptMessageId',
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
promptMessageId: 'promptMessageId',
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
promptMessageId: 'promptMessageId',
role: 'assistant',
},
],
name: 'name',
parameters: {
frequencyPenalty: 0,
maxTokens: 0,
name: 'name',
parallelToolCalls: true,
presencePenalty: 0,
provider: 'ANTHROPIC',
responseFormat: 'JSON',
seed: 0,
stream: true,
temperature: 0,
toolChoice: 'toolChoice',
topK: 1,
topP: 0,
},
tools: [{ toolId: 'toolId' }, { toolId: 'toolId' }, { toolId: 'toolId' }],
});
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.create(
messages=[{
"content": [{
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}],
"prompt_message_id": "promptMessageId",
"role": "assistant",
}, {
"content": [{
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}],
"prompt_message_id": "promptMessageId",
"role": "assistant",
}, {
"content": [{
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}, {
"text": "text",
"type": "TEXT",
}],
"prompt_message_id": "promptMessageId",
"role": "assistant",
}],
name="name",
parameters={
"frequency_penalty": 0,
"max_tokens": 0,
"name": "name",
"parallel_tool_calls": True,
"presence_penalty": 0,
"provider": "ANTHROPIC",
"response_format": "JSON",
"seed": 0,
"stream": True,
"temperature": 0,
"tool_choice": "toolChoice",
"top_k": 1,
"top_p": 0,
},
tools=[{
"tool_id": "toolId"
}, {
"tool_id": "toolId"
}, {
"tool_id": "toolId"
}],
)
print(prompt_configuration.id)curl --request POST \
--url https://api.promptfoundry.ai/sdk/v1/prompts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"tools": [
{
"toolId": "<string>"
}
],
"messages": [
{
"content": [
{
"type": "TEXT",
"text": "<string>"
}
],
"promptMessageId": "<string>"
}
],
"parameters": {
"name": "<string>",
"temperature": 123,
"topP": 123,
"topK": 2,
"frequencyPenalty": 123,
"presencePenalty": 123,
"maxTokens": 123,
"seed": 123,
"toolChoice": "<string>",
"stream": true,
"parallelToolCalls": true
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.promptfoundry.ai/sdk/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>',
'tools' => [
[
'toolId' => '<string>'
]
],
'messages' => [
[
'content' => [
[
'type' => 'TEXT',
'text' => '<string>'
]
],
'promptMessageId' => '<string>'
]
],
'parameters' => [
'name' => '<string>',
'temperature' => 123,
'topP' => 123,
'topK' => 2,
'frequencyPenalty' => 123,
'presencePenalty' => 123,
'maxTokens' => 123,
'seed' => 123,
'toolChoice' => '<string>',
'stream' => true,
'parallelToolCalls' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.promptfoundry.ai/sdk/v1/prompts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tools\": [\n {\n \"toolId\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n }\n ],\n \"promptMessageId\": \"<string>\"\n }\n ],\n \"parameters\": {\n \"name\": \"<string>\",\n \"temperature\": 123,\n \"topP\": 123,\n \"topK\": 2,\n \"frequencyPenalty\": 123,\n \"presencePenalty\": 123,\n \"maxTokens\": 123,\n \"seed\": 123,\n \"toolChoice\": \"<string>\",\n \"stream\": true,\n \"parallelToolCalls\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.promptfoundry.ai/sdk/v1/prompts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tools\": [\n {\n \"toolId\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n }\n ],\n \"promptMessageId\": \"<string>\"\n }\n ],\n \"parameters\": {\n \"name\": \"<string>\",\n \"temperature\": 123,\n \"topP\": 123,\n \"topK\": 2,\n \"frequencyPenalty\": 123,\n \"presencePenalty\": 123,\n \"maxTokens\": 123,\n \"seed\": 123,\n \"toolChoice\": \"<string>\",\n \"stream\": true,\n \"parallelToolCalls\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.promptfoundry.ai/sdk/v1/prompts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tools\": [\n {\n \"toolId\": \"<string>\"\n }\n ],\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"TEXT\",\n \"text\": \"<string>\"\n }\n ],\n \"promptMessageId\": \"<string>\"\n }\n ],\n \"parameters\": {\n \"name\": \"<string>\",\n \"temperature\": 123,\n \"topP\": 123,\n \"topK\": 2,\n \"frequencyPenalty\": 123,\n \"presencePenalty\": 123,\n \"maxTokens\": 123,\n \"seed\": 123,\n \"toolChoice\": \"<string>\",\n \"stream\": true,\n \"parallelToolCalls\": true\n }\n}"
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>"
}Authorizations
Body
application/json
Was this page helpful?
⌘I