Skip to main content
POST
/
{workspace}
/
{project}
/
{prompt}
/
{environment}
cURL
curl --request POST \
  --url https://api.langtail.com/{workspace}/{project}/{prompt}/{environment} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "variables": {
    "variableName": "Your Value"
  },
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false,
  "model": "<string>",
  "max_tokens": 123,
  "temperature": 123,
  "top_p": 123,
  "presence_penalty": 123,
  "frequency_penalty": 123,
  "template": [
    {
      "content": "<string>",
      "name": "<string>",
      "tool_calls": [
        {
          "id": "<string>",
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          }
        }
      ],
      "tool_choice": "auto",
      "tool_call_id": "<string>"
    }
  ],
  "user": "user_123",
  "doNotRecord": false,
  "metadata": {
    "my_identifier": "my-custom-ID"
  },
  "seed": 123
}
'
import requests

url = "https://api.langtail.com/{workspace}/{project}/{prompt}/{environment}"

payload = {
    "variables": { "variableName": "Your Value" },
    "messages": [
        {
            "role": "user",
            "content": "Hello"
        }
    ],
    "stream": False,
    "model": "<string>",
    "max_tokens": 123,
    "temperature": 123,
    "top_p": 123,
    "presence_penalty": 123,
    "frequency_penalty": 123,
    "template": [
        {
            "content": "<string>",
            "name": "<string>",
            "tool_calls": [
                {
                    "id": "<string>",
                    "type": "function",
                    "function": {
                        "name": "<string>",
                        "arguments": "<string>"
                    }
                }
            ],
            "tool_choice": "auto",
            "tool_call_id": "<string>"
        }
    ],
    "user": "user_123",
    "doNotRecord": False,
    "metadata": { "my_identifier": "my-custom-ID" },
    "seed": 123
}
headers = {
    "X-API-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    variables: {variableName: 'Your Value'},
    messages: [{role: 'user', content: 'Hello'}],
    stream: false,
    model: '<string>',
    max_tokens: 123,
    temperature: 123,
    top_p: 123,
    presence_penalty: 123,
    frequency_penalty: 123,
    template: [
      {
        content: '<string>',
        name: '<string>',
        tool_calls: [
          {
            id: '<string>',
            type: 'function',
            function: {name: '<string>', arguments: '<string>'}
          }
        ],
        tool_choice: 'auto',
        tool_call_id: '<string>'
      }
    ],
    user: 'user_123',
    doNotRecord: false,
    metadata: {my_identifier: 'my-custom-ID'},
    seed: 123
  })
};

fetch('https://api.langtail.com/{workspace}/{project}/{prompt}/{environment}', 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.langtail.com/{workspace}/{project}/{prompt}/{environment}",
  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([
    'variables' => [
        'variableName' => 'Your Value'
    ],
    'messages' => [
        [
                'role' => 'user',
                'content' => 'Hello'
        ]
    ],
    'stream' => false,
    'model' => '<string>',
    'max_tokens' => 123,
    'temperature' => 123,
    'top_p' => 123,
    'presence_penalty' => 123,
    'frequency_penalty' => 123,
    'template' => [
        [
                'content' => '<string>',
                'name' => '<string>',
                'tool_calls' => [
                                [
                                                                'id' => '<string>',
                                                                'type' => 'function',
                                                                'function' => [
                                                                                                                                'name' => '<string>',
                                                                                                                                'arguments' => '<string>'
                                                                ]
                                ]
                ],
                'tool_choice' => 'auto',
                'tool_call_id' => '<string>'
        ]
    ],
    'user' => 'user_123',
    'doNotRecord' => false,
    'metadata' => [
        'my_identifier' => 'my-custom-ID'
    ],
    'seed' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <x-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.langtail.com/{workspace}/{project}/{prompt}/{environment}"

	payload := strings.NewReader("{\n  \"variables\": {\n    \"variableName\": \"Your Value\"\n  },\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"Hello\"\n    }\n  ],\n  \"stream\": false,\n  \"model\": \"<string>\",\n  \"max_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"presence_penalty\": 123,\n  \"frequency_penalty\": 123,\n  \"template\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"tool_choice\": \"auto\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"user\": \"user_123\",\n  \"doNotRecord\": false,\n  \"metadata\": {\n    \"my_identifier\": \"my-custom-ID\"\n  },\n  \"seed\": 123\n}")

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

	req.Header.Add("X-API-Key", "<x-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.langtail.com/{workspace}/{project}/{prompt}/{environment}")
  .header("X-API-Key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variables\": {\n    \"variableName\": \"Your Value\"\n  },\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"Hello\"\n    }\n  ],\n  \"stream\": false,\n  \"model\": \"<string>\",\n  \"max_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"presence_penalty\": 123,\n  \"frequency_penalty\": 123,\n  \"template\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"tool_choice\": \"auto\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"user\": \"user_123\",\n  \"doNotRecord\": false,\n  \"metadata\": {\n    \"my_identifier\": \"my-custom-ID\"\n  },\n  \"seed\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.langtail.com/{workspace}/{project}/{prompt}/{environment}")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variables\": {\n    \"variableName\": \"Your Value\"\n  },\n  \"messages\": [\n    {\n      \"role\": \"user\",\n      \"content\": \"Hello\"\n    }\n  ],\n  \"stream\": false,\n  \"model\": \"<string>\",\n  \"max_tokens\": 123,\n  \"temperature\": 123,\n  \"top_p\": 123,\n  \"presence_penalty\": 123,\n  \"frequency_penalty\": 123,\n  \"template\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"tool_choice\": \"auto\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"user\": \"user_123\",\n  \"doNotRecord\": false,\n  \"metadata\": {\n    \"my_identifier\": \"my-custom-ID\"\n  },\n  \"seed\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "model": "<string>",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "I'm sorry, but I'm not able to fulfill this request."
      }
    }
  ]
}
{
  "error": "Invalid request body",
  "issues": [
    {
      "code": "unrecognized_keys",
      "keys": [
        "unknown_variable"
      ],
      "path": [
        "variables"
      ],
      "message": "Unrecognized key(s) in object: 'unknown_variable'"
    }
  ]
}

Headers

​
X-API-Key
string
required

Your Langtail API Key

Example:

"<LANGTAIL_API_KEY>"

Path Parameters

​
workspace
string
required

Your workspace URL slug

Example:

"workspace"

​
project
string
required

Your project URL slug

Example:

"project"

​
prompt
string
required

Your prompt URL slug

Example:

"prompt"

​
environment
string
required

Your environment URL slug

Example:

"production"

Body

application/json
​
variables
object

A mapping of variable names to their values. Will be injected in your saved prompt template.

Example:
{ "variableName": "Your Value" }
​
messages
object[]

Additional messages. These will be appended to the Prompt Template.

Example:
[{ "role": "user", "content": "Hello" }]
​
stream
boolean
Example:

false

​
model
string

Overrides the model of deployed prompt.

​
max_tokens
number

Overrides the max tokens of deployed prompt. The maximum number of tokens that can be generated in the completion.

​
temperature
number

Overrides the temperature of deployed prompt. What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

​
top_p
number

Overrides the top_p of deployed prompt. An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

​
presence_penalty
number

Overrides the presence_penalty of deployed prompt.

​
frequency_penalty
number

Overrides the frequency_penalty of deployed prompt.

​
template
object[]

Overrides the stored template messages with custom template messages.

​
tool_choice

Overrides the tool choice of deployed prompt.

Available options:
auto,
required,
none
​
response_format
object

Overrides the response format of deployed prompt.

​
user
string

A unique identifier representing your end-user

Example:

"user_123"

​
doNotRecord
boolean

If true, potentially sensitive data like the prompt and response will not be recorded in the logs

Example:

false

​
metadata
object

Additional custom data that will be stored for this request

Example:
{ "my_identifier": "my-custom-ID" }
​
seed
number

A seed is used to generate reproducible results

Example:

123

Response

Chat completion response from OpenAI - see https://platform.openai.com/docs/api-reference/chat/object for more details.

​
id
string
required

A unique identifier for the chat completion.

​
object
string
required

The object type, which is always chat.completion.

​
created
number
required

The Unix timestamp (in seconds) of when the chat completion was created.

​
model
string
required

The model used for the chat completion.

​
choices
object[]
required

A list of chat completion choices. Can be more than one if n is greater than 1.