Create a model response
curl --request POST \
--url http://localhost:3000/api/gateway/v1/responses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "openai/gpt-4o-mini",
"input": "<string>",
"metadata": {
"waystone": "{\n\t\t\t\t\t\t\"user\": {\n\t\t\t\t\t\t\t\"id\": \"user123\",\n\t\t\t\t\t\t\t\"metadata\": { \"email\": \"user@example.com\", \"name\": \"John Doe\" }\n\t\t\t\t\t\t}\n\t\t\t\t\t}"
},
"store": false,
"stream": false,
"user": "<string>",
"temperature": 1,
"frequency_penalty": 0,
"max_completion_tokens": 123,
"n": 1
}
'import requests
url = "http://localhost:3000/api/gateway/v1/responses"
payload = {
"model": "openai/gpt-4o-mini",
"input": "<string>",
"metadata": { "waystone": "{
\"user\": {
\"id\": \"user123\",
\"metadata\": { \"email\": \"user@example.com\", \"name\": \"John Doe\" }
}
}" },
"store": False,
"stream": False,
"user": "<string>",
"temperature": 1,
"frequency_penalty": 0,
"max_completion_tokens": 123,
"n": 1
}
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({
model: 'openai/gpt-4o-mini',
input: '<string>',
metadata: {
waystone: '{\n "user": {\n "id": "user123",\n "metadata": { "email": "user@example.com", "name": "John Doe" }\n }\n }'
},
store: false,
stream: false,
user: '<string>',
temperature: 1,
frequency_penalty: 0,
max_completion_tokens: 123,
n: 1
})
};
fetch('http://localhost:3000/api/gateway/v1/responses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/gateway/v1/responses",
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([
'model' => 'openai/gpt-4o-mini',
'input' => '<string>',
'metadata' => [
'waystone' => '{
\t\t\t\t\t\t"user": {
\t\t\t\t\t\t\t"id": "user123",
\t\t\t\t\t\t\t"metadata": { "email": "user@example.com", "name": "John Doe" }
\t\t\t\t\t\t}
\t\t\t\t\t}'
],
'store' => false,
'stream' => false,
'user' => '<string>',
'temperature' => 1,
'frequency_penalty' => 0,
'max_completion_tokens' => 123,
'n' => 1
]),
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 := "http://localhost:3000/api/gateway/v1/responses"
payload := strings.NewReader("{\n \"model\": \"openai/gpt-4o-mini\",\n \"input\": \"<string>\",\n \"metadata\": {\n \"waystone\": \"{\\n\\t\\t\\t\\t\\t\\t\\\"user\\\": {\\n\\t\\t\\t\\t\\t\\t\\t\\\"id\\\": \\\"user123\\\",\\n\\t\\t\\t\\t\\t\\t\\t\\\"metadata\\\": { \\\"email\\\": \\\"user@example.com\\\", \\\"name\\\": \\\"John Doe\\\" }\\n\\t\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t\\t}\"\n },\n \"store\": false,\n \"stream\": false,\n \"user\": \"<string>\",\n \"temperature\": 1,\n \"frequency_penalty\": 0,\n \"max_completion_tokens\": 123,\n \"n\": 1\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("http://localhost:3000/api/gateway/v1/responses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"openai/gpt-4o-mini\",\n \"input\": \"<string>\",\n \"metadata\": {\n \"waystone\": \"{\\n\\t\\t\\t\\t\\t\\t\\\"user\\\": {\\n\\t\\t\\t\\t\\t\\t\\t\\\"id\\\": \\\"user123\\\",\\n\\t\\t\\t\\t\\t\\t\\t\\\"metadata\\\": { \\\"email\\\": \\\"user@example.com\\\", \\\"name\\\": \\\"John Doe\\\" }\\n\\t\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t\\t}\"\n },\n \"store\": false,\n \"stream\": false,\n \"user\": \"<string>\",\n \"temperature\": 1,\n \"frequency_penalty\": 0,\n \"max_completion_tokens\": 123,\n \"n\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/gateway/v1/responses")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": \"openai/gpt-4o-mini\",\n \"input\": \"<string>\",\n \"metadata\": {\n \"waystone\": \"{\\n\\t\\t\\t\\t\\t\\t\\\"user\\\": {\\n\\t\\t\\t\\t\\t\\t\\t\\\"id\\\": \\\"user123\\\",\\n\\t\\t\\t\\t\\t\\t\\t\\\"metadata\\\": { \\\"email\\\": \\\"user@example.com\\\", \\\"name\\\": \\\"John Doe\\\" }\\n\\t\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t\\t}\"\n },\n \"store\": false,\n \"stream\": false,\n \"user\": \"<string>\",\n \"temperature\": 1,\n \"frequency_penalty\": 0,\n \"max_completion_tokens\": 123,\n \"n\": 1\n}"
response = http.request(request)
puts response.read_body{}Waystone Gateway
Create a model response
Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model’s response.
POST
/
api
/
gateway
/
v1
/
responses
Create a model response
curl --request POST \
--url http://localhost:3000/api/gateway/v1/responses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "openai/gpt-4o-mini",
"input": "<string>",
"metadata": {
"waystone": "{\n\t\t\t\t\t\t\"user\": {\n\t\t\t\t\t\t\t\"id\": \"user123\",\n\t\t\t\t\t\t\t\"metadata\": { \"email\": \"user@example.com\", \"name\": \"John Doe\" }\n\t\t\t\t\t\t}\n\t\t\t\t\t}"
},
"store": false,
"stream": false,
"user": "<string>",
"temperature": 1,
"frequency_penalty": 0,
"max_completion_tokens": 123,
"n": 1
}
'import requests
url = "http://localhost:3000/api/gateway/v1/responses"
payload = {
"model": "openai/gpt-4o-mini",
"input": "<string>",
"metadata": { "waystone": "{
\"user\": {
\"id\": \"user123\",
\"metadata\": { \"email\": \"user@example.com\", \"name\": \"John Doe\" }
}
}" },
"store": False,
"stream": False,
"user": "<string>",
"temperature": 1,
"frequency_penalty": 0,
"max_completion_tokens": 123,
"n": 1
}
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({
model: 'openai/gpt-4o-mini',
input: '<string>',
metadata: {
waystone: '{\n "user": {\n "id": "user123",\n "metadata": { "email": "user@example.com", "name": "John Doe" }\n }\n }'
},
store: false,
stream: false,
user: '<string>',
temperature: 1,
frequency_penalty: 0,
max_completion_tokens: 123,
n: 1
})
};
fetch('http://localhost:3000/api/gateway/v1/responses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/gateway/v1/responses",
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([
'model' => 'openai/gpt-4o-mini',
'input' => '<string>',
'metadata' => [
'waystone' => '{
\t\t\t\t\t\t"user": {
\t\t\t\t\t\t\t"id": "user123",
\t\t\t\t\t\t\t"metadata": { "email": "user@example.com", "name": "John Doe" }
\t\t\t\t\t\t}
\t\t\t\t\t}'
],
'store' => false,
'stream' => false,
'user' => '<string>',
'temperature' => 1,
'frequency_penalty' => 0,
'max_completion_tokens' => 123,
'n' => 1
]),
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 := "http://localhost:3000/api/gateway/v1/responses"
payload := strings.NewReader("{\n \"model\": \"openai/gpt-4o-mini\",\n \"input\": \"<string>\",\n \"metadata\": {\n \"waystone\": \"{\\n\\t\\t\\t\\t\\t\\t\\\"user\\\": {\\n\\t\\t\\t\\t\\t\\t\\t\\\"id\\\": \\\"user123\\\",\\n\\t\\t\\t\\t\\t\\t\\t\\\"metadata\\\": { \\\"email\\\": \\\"user@example.com\\\", \\\"name\\\": \\\"John Doe\\\" }\\n\\t\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t\\t}\"\n },\n \"store\": false,\n \"stream\": false,\n \"user\": \"<string>\",\n \"temperature\": 1,\n \"frequency_penalty\": 0,\n \"max_completion_tokens\": 123,\n \"n\": 1\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("http://localhost:3000/api/gateway/v1/responses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"openai/gpt-4o-mini\",\n \"input\": \"<string>\",\n \"metadata\": {\n \"waystone\": \"{\\n\\t\\t\\t\\t\\t\\t\\\"user\\\": {\\n\\t\\t\\t\\t\\t\\t\\t\\\"id\\\": \\\"user123\\\",\\n\\t\\t\\t\\t\\t\\t\\t\\\"metadata\\\": { \\\"email\\\": \\\"user@example.com\\\", \\\"name\\\": \\\"John Doe\\\" }\\n\\t\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t\\t}\"\n },\n \"store\": false,\n \"stream\": false,\n \"user\": \"<string>\",\n \"temperature\": 1,\n \"frequency_penalty\": 0,\n \"max_completion_tokens\": 123,\n \"n\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/gateway/v1/responses")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": \"openai/gpt-4o-mini\",\n \"input\": \"<string>\",\n \"metadata\": {\n \"waystone\": \"{\\n\\t\\t\\t\\t\\t\\t\\\"user\\\": {\\n\\t\\t\\t\\t\\t\\t\\t\\\"id\\\": \\\"user123\\\",\\n\\t\\t\\t\\t\\t\\t\\t\\\"metadata\\\": { \\\"email\\\": \\\"user@example.com\\\", \\\"name\\\": \\\"John Doe\\\" }\\n\\t\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t\\t}\"\n },\n \"store\": false,\n \"stream\": false,\n \"user\": \"<string>\",\n \"temperature\": 1,\n \"frequency_penalty\": 0,\n \"max_completion_tokens\": 123,\n \"n\": 1\n}"
response = http.request(request)
puts response.read_body{}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
/ to use in the query. If is unique across providers, can supply only
Examples:
"openai/gpt-4o-mini"
"gpt-4o-mini"
Key-value pairs of metadata for the request. Identify end-users associated with the query with the waystone metadata. All other fields are metadata for OpenAI requests and are not used by Waystone.
Show child attributes
Show child attributes
Examples:
{
"waystone": "{\n\t\t\t\t\t\t\"user\": {\n\t\t\t\t\t\t\t\"id\": \"user123\",\n\t\t\t\t\t\t\t\"metadata\": { \"email\": \"user@example.com\", \"name\": \"John Doe\" }\n\t\t\t\t\t\t}\n\t\t\t\t\t}"
}
{
"waystone": "{\n\t\t\t\t\t\t\"user\": \"user123\",\n\t\t\t\t\t\t\"group\": { \"id\": \"group123\", \"metadata\": { \"name\": \"Group Name\" } }\n\t\t\t\t\t}"
}
For OpenAI: Whether or not to store the output of this chat completion request in OpenAI
If set to true, the model response data will be streamed to the client as it is generated
For OpenAI: A unique identifier representing your end-user. NOT used by Waystone.
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. We generally recommend altering this or top_p but not both.
Required range:
0 <= x <= 2Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
Required range:
-2 <= x <= 2An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.
Response
200 - application/json
Successful response
The response is of type object.