Run a prompt version through the gateway playground

POST /v1/prompts/run

Run a prompt version through the gateway playground

cURL

curl --request POST \
  --url https://api.example.com/v1/prompts/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "promptId": "<string>",
  "versionId": "<string>",
  "variables": {}
}
'

import requests

url = "https://api.example.com/v1/prompts/run"

payload = {
    "promptId": "<string>",
    "versionId": "<string>",
    "variables": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({promptId: '<string>', versionId: '<string>', variables: {}})
};

fetch('https://api.example.com/v1/prompts/run', 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.example.com/v1/prompts/run",
  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([
    'promptId' => '<string>',
    'versionId' => '<string>',
    'variables' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/v1/prompts/run"

	payload := strings.NewReader("{\n  \"promptId\": \"<string>\",\n  \"versionId\": \"<string>\",\n  \"variables\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/v1/prompts/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"promptId\": \"<string>\",\n  \"versionId\": \"<string>\",\n  \"variables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/prompts/run")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"promptId\": \"<string>\",\n  \"versionId\": \"<string>\",\n  \"variables\": {}\n}"

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

200

{
  "output": "<string>",
  "inputTokens": 123,
  "outputTokens": 123,
  "costUsd": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

promptId · string · required

Parent prompt UUID

versionId · string · required

Version UUID to run

variables · object | null · required

Variable substitution map for {{key}} placeholders

Show child attributes

Response

200 - application/json

output · string · required

Model output text

inputTokens · number · required

Prompt tokens consumed (excl. cache tokens)

outputTokens · number · required

Completion tokens produced

costUsd · number · required

Estimated cost in USD