curl https://gateway.obiguard.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "x-obiguard-api-key: $OBIGUARD_API_KEY" \
-d '{
"model": "gpt-4o",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello!"
}
]
}'from obiguard import Obiguard
client = Obiguard(
obiguard_api_key="ak***", # Your Obiguard access key
)
response = client.chat.completions.create(
model="gpt-4o",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello!"}
]
)
print(response.choices[0].message)
const options = {
method: 'POST',
headers: {'x-obiguard-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{content: '<string>', role: 'system', name: '<string>'}],
model: 'gpt-4-turbo',
frequency_penalty: 0,
logit_bias: null,
logprobs: false,
top_logprobs: 10,
max_tokens: 123,
n: 1,
presence_penalty: 0,
response_format: {type: 'text'},
seed: 0,
stop: '<string>',
stream: false,
stream_options: null,
thinking: {type: 'enabled', budget_tokens: 2030},
temperature: 1,
top_p: 1,
tools: [
{
type: 'function',
function: {name: '<string>', description: '<string>', parameters: {}}
}
],
parallel_tool_calls: true,
user: 'user-1234',
functions: [{name: '<string>', description: '<string>', parameters: {}}]
})
};
fetch('https://gateway.obiguard.ai/v1/chat/completions', 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://gateway.obiguard.ai/v1/chat/completions",
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([
'messages' => [
[
'content' => '<string>',
'role' => 'system',
'name' => '<string>'
]
],
'model' => 'gpt-4-turbo',
'frequency_penalty' => 0,
'logit_bias' => null,
'logprobs' => false,
'top_logprobs' => 10,
'max_tokens' => 123,
'n' => 1,
'presence_penalty' => 0,
'response_format' => [
'type' => 'text'
],
'seed' => 0,
'stop' => '<string>',
'stream' => false,
'stream_options' => null,
'thinking' => [
'type' => 'enabled',
'budget_tokens' => 2030
],
'temperature' => 1,
'top_p' => 1,
'tools' => [
[
'type' => 'function',
'function' => [
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
]
],
'parallel_tool_calls' => true,
'user' => 'user-1234',
'functions' => [
[
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-obiguard-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://gateway.obiguard.ai/v1/chat/completions"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"system\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"gpt-4-turbo\",\n \"frequency_penalty\": 0,\n \"logit_bias\": null,\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"type\": \"text\"\n },\n \"seed\": 0,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": null,\n \"thinking\": {\n \"type\": \"enabled\",\n \"budget_tokens\": 2030\n },\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n }\n ],\n \"parallel_tool_calls\": true,\n \"user\": \"user-1234\",\n \"functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-obiguard-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://gateway.obiguard.ai/v1/chat/completions")
.header("x-obiguard-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"system\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"gpt-4-turbo\",\n \"frequency_penalty\": 0,\n \"logit_bias\": null,\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"type\": \"text\"\n },\n \"seed\": 0,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": null,\n \"thinking\": {\n \"type\": \"enabled\",\n \"budget_tokens\": 2030\n },\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n }\n ],\n \"parallel_tool_calls\": true,\n \"user\": \"user-1234\",\n \"functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.obiguard.ai/v1/chat/completions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-obiguard-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"system\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"gpt-4-turbo\",\n \"frequency_penalty\": 0,\n \"logit_bias\": null,\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"type\": \"text\"\n },\n \"seed\": 0,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": null,\n \"thinking\": {\n \"type\": \"enabled\",\n \"budget_tokens\": 2030\n },\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n }\n ],\n \"parallel_tool_calls\": true,\n \"user\": \"user-1234\",\n \"functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"choices": [
{
"finish_reason": "stop",
"index": 123,
"message": {
"content": "<string>",
"role": "assistant",
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"function_call": {
"arguments": "<string>",
"name": "<string>"
},
"content_blocks": [
{
"type": "text",
"text": "<string>"
}
]
},
"logprobs": {
"content": [
{
"token": "<string>",
"logprob": 123,
"bytes": [
123
],
"top_logprobs": [
{
"token": "<string>",
"logprob": 123,
"bytes": [
123
]
}
]
}
]
}
}
],
"created": 123,
"model": "<string>",
"object": "chat.completion",
"system_fingerprint": "<string>",
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123
}
}Chat
curl https://gateway.obiguard.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "x-obiguard-api-key: $OBIGUARD_API_KEY" \
-d '{
"model": "gpt-4o",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello!"
}
]
}'from obiguard import Obiguard
client = Obiguard(
obiguard_api_key="ak***", # Your Obiguard access key
)
response = client.chat.completions.create(
model="gpt-4o",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello!"}
]
)
print(response.choices[0].message)
const options = {
method: 'POST',
headers: {'x-obiguard-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messages: [{content: '<string>', role: 'system', name: '<string>'}],
model: 'gpt-4-turbo',
frequency_penalty: 0,
logit_bias: null,
logprobs: false,
top_logprobs: 10,
max_tokens: 123,
n: 1,
presence_penalty: 0,
response_format: {type: 'text'},
seed: 0,
stop: '<string>',
stream: false,
stream_options: null,
thinking: {type: 'enabled', budget_tokens: 2030},
temperature: 1,
top_p: 1,
tools: [
{
type: 'function',
function: {name: '<string>', description: '<string>', parameters: {}}
}
],
parallel_tool_calls: true,
user: 'user-1234',
functions: [{name: '<string>', description: '<string>', parameters: {}}]
})
};
fetch('https://gateway.obiguard.ai/v1/chat/completions', 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://gateway.obiguard.ai/v1/chat/completions",
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([
'messages' => [
[
'content' => '<string>',
'role' => 'system',
'name' => '<string>'
]
],
'model' => 'gpt-4-turbo',
'frequency_penalty' => 0,
'logit_bias' => null,
'logprobs' => false,
'top_logprobs' => 10,
'max_tokens' => 123,
'n' => 1,
'presence_penalty' => 0,
'response_format' => [
'type' => 'text'
],
'seed' => 0,
'stop' => '<string>',
'stream' => false,
'stream_options' => null,
'thinking' => [
'type' => 'enabled',
'budget_tokens' => 2030
],
'temperature' => 1,
'top_p' => 1,
'tools' => [
[
'type' => 'function',
'function' => [
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
]
],
'parallel_tool_calls' => true,
'user' => 'user-1234',
'functions' => [
[
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-obiguard-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://gateway.obiguard.ai/v1/chat/completions"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"system\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"gpt-4-turbo\",\n \"frequency_penalty\": 0,\n \"logit_bias\": null,\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"type\": \"text\"\n },\n \"seed\": 0,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": null,\n \"thinking\": {\n \"type\": \"enabled\",\n \"budget_tokens\": 2030\n },\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n }\n ],\n \"parallel_tool_calls\": true,\n \"user\": \"user-1234\",\n \"functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-obiguard-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://gateway.obiguard.ai/v1/chat/completions")
.header("x-obiguard-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"system\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"gpt-4-turbo\",\n \"frequency_penalty\": 0,\n \"logit_bias\": null,\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"type\": \"text\"\n },\n \"seed\": 0,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": null,\n \"thinking\": {\n \"type\": \"enabled\",\n \"budget_tokens\": 2030\n },\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n }\n ],\n \"parallel_tool_calls\": true,\n \"user\": \"user-1234\",\n \"functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.obiguard.ai/v1/chat/completions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-obiguard-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"system\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"gpt-4-turbo\",\n \"frequency_penalty\": 0,\n \"logit_bias\": null,\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"type\": \"text\"\n },\n \"seed\": 0,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": null,\n \"thinking\": {\n \"type\": \"enabled\",\n \"budget_tokens\": 2030\n },\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {\n \"type\": \"function\",\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n }\n ],\n \"parallel_tool_calls\": true,\n \"user\": \"user-1234\",\n \"functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"choices": [
{
"finish_reason": "stop",
"index": 123,
"message": {
"content": "<string>",
"role": "assistant",
"tool_calls": [
{
"id": "<string>",
"type": "function",
"function": {
"name": "<string>",
"arguments": "<string>"
}
}
],
"function_call": {
"arguments": "<string>",
"name": "<string>"
},
"content_blocks": [
{
"type": "text",
"text": "<string>"
}
]
},
"logprobs": {
"content": [
{
"token": "<string>",
"logprob": 123,
"bytes": [
123
],
"top_logprobs": [
{
"token": "<string>",
"logprob": 123,
"bytes": [
123
]
}
]
}
]
}
}
],
"created": 123,
"model": "<string>",
"object": "chat.completion",
"system_fingerprint": "<string>",
"usage": {
"completion_tokens": 123,
"prompt_tokens": 123,
"total_tokens": 123
}
}Authorizations
Body
A list of messages comprising the conversation so far. Example Python code.
1- System message
- Developer message
- User message
- Assistant message
- Tool message
- Function message
Show child attributes
Show child attributes
ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.
"gpt-4-turbo"
Number 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.
See more information about frequency and presence penalties.
-2 <= x <= 2Modify the likelihood of specified tokens appearing in the completion.
Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
Show child attributes
Show child attributes
Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.
An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.
0 <= x <= 20The maximum number of tokens that can be generated in the chat completion.
The total length of input tokens and generated tokens is limited by the model's context length. Example Python code for counting 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.
1 <= x <= 1281
Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
See more information about frequency and presence penalties.
-2 <= x <= 2Default response format. Used to generate text responses.
- Text
- JSON schema
- JSON object
Show child attributes
Show child attributes
This feature is in Beta.
If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.
Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.
-9223372036854776000 <= x <= 9223372036854776000Up to 4 sequences where the API will stop generating further tokens.
If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Example Python code.
Options for streaming response. Only set this when you set stream: true.
Show child attributes
Show child attributes
View the thinking/reasoning tokens as part of your response. Thinking models produce a long internal chain of thought before generating a response. Supported only for specific Claude models on Anthropic, Google Vertex AI, and AWS Bedrock. Requires setting strict_openai_compliance = false in your API call.
Show child attributes
Show child attributes
{ "type": "enabled", "budget_tokens": 2030 }
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.
0 <= x <= 21
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.
0 <= x <= 11
A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.
Show child attributes
Show child attributes
Controls which (if any) tool is called by the model.
none means the model will not call any tool and instead generates a message.
auto means the model can pick between generating a message or calling one or more tools.
required means the model must call one or more tools.
Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
none is the default when no tools are present. auto is the default if tools are present.
none, auto, required Whether to enable parallel function calling during tool use.
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
"user-1234"
Deprecated in favor of tool_choice.
Controls which (if any) function is called by the model.
none means the model will not call a function and instead generates a message.
auto means the model can pick between generating a message or calling a function.
Specifying a particular function via {"name": "my_function"} forces the model to call that function.
none is the default when no functions are present. auto is the default if functions are present.
none, auto Deprecated in favor of tools.
A list of functions the model may generate JSON inputs for.
1 - 128 elementsShow child attributes
Show child attributes
Response
OK
Represents a chat completion response returned by model, based on the provided input.
A unique identifier for the chat completion.
A list of chat completion choices. Can be more than one if n is greater than 1.
Show child attributes
Show child attributes
The Unix timestamp (in seconds) of when the chat completion was created.
The model used for the chat completion.
The object type, which is always chat.completion.
chat.completion This fingerprint represents the backend configuration that the model runs with.
Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.
Usage statistics for the completion request.
Show child attributes
Show child attributes