curl --request POST \
--url https://api.edenai.run/v3/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"messages": [
{
"content": "<string>",
"cache_control": {
"type": "ephemeral",
"ttl": "<string>"
}
}
],
"routing": {
"sticky": true,
"allow_fallbacks": true,
"quality_cost": 5,
"allowed_providers": [
"<string>"
]
},
"fallbacks": [
"<string>"
],
"session_id": "<string>",
"router_candidates": [
"<string>"
],
"pre_hooks": [
{}
],
"post_hooks": [
{}
],
"n": 1,
"metadata": {},
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": false,
"top_logprobs": 10,
"max_tokens": 2,
"max_completion_tokens": 2,
"modalities": [
"<string>"
],
"prediction": {},
"audio": {},
"presence_penalty": 0,
"response_format": {},
"seed": 123,
"stop": "<string>",
"stream": false,
"stream_options": {},
"temperature": 1,
"top_p": 1,
"tools": [
{}
],
"tool_choice": "<string>",
"parallel_tool_calls": true,
"user": "<string>",
"functions": [
{}
],
"thinking": {},
"web_search_options": {},
"prompt_cache_key": "<string>",
"prompt_cache_options": {
"ttl": "30m"
},
"extra_body": {},
"image_config": {
"aspect_ratio": "<string>",
"image_size": "<string>"
},
"extra_headers": {}
}
'import requests
url = "https://api.edenai.run/v3/chat/completions"
payload = {
"model": "<string>",
"messages": [
{
"content": "<string>",
"cache_control": {
"type": "ephemeral",
"ttl": "<string>"
}
}
],
"routing": {
"sticky": True,
"allow_fallbacks": True,
"quality_cost": 5,
"allowed_providers": ["<string>"]
},
"fallbacks": ["<string>"],
"session_id": "<string>",
"router_candidates": ["<string>"],
"pre_hooks": [{}],
"post_hooks": [{}],
"n": 1,
"metadata": {},
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": False,
"top_logprobs": 10,
"max_tokens": 2,
"max_completion_tokens": 2,
"modalities": ["<string>"],
"prediction": {},
"audio": {},
"presence_penalty": 0,
"response_format": {},
"seed": 123,
"stop": "<string>",
"stream": False,
"stream_options": {},
"temperature": 1,
"top_p": 1,
"tools": [{}],
"tool_choice": "<string>",
"parallel_tool_calls": True,
"user": "<string>",
"functions": [{}],
"thinking": {},
"web_search_options": {},
"prompt_cache_key": "<string>",
"prompt_cache_options": { "ttl": "30m" },
"extra_body": {},
"image_config": {
"aspect_ratio": "<string>",
"image_size": "<string>"
},
"extra_headers": {}
}
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: '<string>',
messages: [{content: '<string>', cache_control: {type: 'ephemeral', ttl: '<string>'}}],
routing: {
sticky: true,
allow_fallbacks: true,
quality_cost: 5,
allowed_providers: ['<string>']
},
fallbacks: ['<string>'],
session_id: '<string>',
router_candidates: ['<string>'],
pre_hooks: [{}],
post_hooks: [{}],
n: 1,
metadata: {},
frequency_penalty: 0,
logit_bias: {},
logprobs: false,
top_logprobs: 10,
max_tokens: 2,
max_completion_tokens: 2,
modalities: ['<string>'],
prediction: {},
audio: {},
presence_penalty: 0,
response_format: {},
seed: 123,
stop: '<string>',
stream: false,
stream_options: {},
temperature: 1,
top_p: 1,
tools: [{}],
tool_choice: '<string>',
parallel_tool_calls: true,
user: '<string>',
functions: [{}],
thinking: {},
web_search_options: {},
prompt_cache_key: '<string>',
prompt_cache_options: {ttl: '30m'},
extra_body: {},
image_config: {aspect_ratio: '<string>', image_size: '<string>'},
extra_headers: {}
})
};
fetch('https://api.edenai.run/v3/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://api.edenai.run/v3/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([
'model' => '<string>',
'messages' => [
[
'content' => '<string>',
'cache_control' => [
'type' => 'ephemeral',
'ttl' => '<string>'
]
]
],
'routing' => [
'sticky' => true,
'allow_fallbacks' => true,
'quality_cost' => 5,
'allowed_providers' => [
'<string>'
]
],
'fallbacks' => [
'<string>'
],
'session_id' => '<string>',
'router_candidates' => [
'<string>'
],
'pre_hooks' => [
[
]
],
'post_hooks' => [
[
]
],
'n' => 1,
'metadata' => [
],
'frequency_penalty' => 0,
'logit_bias' => [
],
'logprobs' => false,
'top_logprobs' => 10,
'max_tokens' => 2,
'max_completion_tokens' => 2,
'modalities' => [
'<string>'
],
'prediction' => [
],
'audio' => [
],
'presence_penalty' => 0,
'response_format' => [
],
'seed' => 123,
'stop' => '<string>',
'stream' => false,
'stream_options' => [
],
'temperature' => 1,
'top_p' => 1,
'tools' => [
[
]
],
'tool_choice' => '<string>',
'parallel_tool_calls' => true,
'user' => '<string>',
'functions' => [
[
]
],
'thinking' => [
],
'web_search_options' => [
],
'prompt_cache_key' => '<string>',
'prompt_cache_options' => [
'ttl' => '30m'
],
'extra_body' => [
],
'image_config' => [
'aspect_ratio' => '<string>',
'image_size' => '<string>'
],
'extra_headers' => [
]
]),
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.edenai.run/v3/chat/completions"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"cache_control\": {\n \"type\": \"ephemeral\",\n \"ttl\": \"<string>\"\n }\n }\n ],\n \"routing\": {\n \"sticky\": true,\n \"allow_fallbacks\": true,\n \"quality_cost\": 5,\n \"allowed_providers\": [\n \"<string>\"\n ]\n },\n \"fallbacks\": [\n \"<string>\"\n ],\n \"session_id\": \"<string>\",\n \"router_candidates\": [\n \"<string>\"\n ],\n \"pre_hooks\": [\n {}\n ],\n \"post_hooks\": [\n {}\n ],\n \"n\": 1,\n \"metadata\": {},\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 2,\n \"max_completion_tokens\": 2,\n \"modalities\": [\n \"<string>\"\n ],\n \"prediction\": {},\n \"audio\": {},\n \"presence_penalty\": 0,\n \"response_format\": {},\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {},\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {}\n ],\n \"tool_choice\": \"<string>\",\n \"parallel_tool_calls\": true,\n \"user\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"thinking\": {},\n \"web_search_options\": {},\n \"prompt_cache_key\": \"<string>\",\n \"prompt_cache_options\": {\n \"ttl\": \"30m\"\n },\n \"extra_body\": {},\n \"image_config\": {\n \"aspect_ratio\": \"<string>\",\n \"image_size\": \"<string>\"\n },\n \"extra_headers\": {}\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.edenai.run/v3/chat/completions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"cache_control\": {\n \"type\": \"ephemeral\",\n \"ttl\": \"<string>\"\n }\n }\n ],\n \"routing\": {\n \"sticky\": true,\n \"allow_fallbacks\": true,\n \"quality_cost\": 5,\n \"allowed_providers\": [\n \"<string>\"\n ]\n },\n \"fallbacks\": [\n \"<string>\"\n ],\n \"session_id\": \"<string>\",\n \"router_candidates\": [\n \"<string>\"\n ],\n \"pre_hooks\": [\n {}\n ],\n \"post_hooks\": [\n {}\n ],\n \"n\": 1,\n \"metadata\": {},\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 2,\n \"max_completion_tokens\": 2,\n \"modalities\": [\n \"<string>\"\n ],\n \"prediction\": {},\n \"audio\": {},\n \"presence_penalty\": 0,\n \"response_format\": {},\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {},\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {}\n ],\n \"tool_choice\": \"<string>\",\n \"parallel_tool_calls\": true,\n \"user\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"thinking\": {},\n \"web_search_options\": {},\n \"prompt_cache_key\": \"<string>\",\n \"prompt_cache_options\": {\n \"ttl\": \"30m\"\n },\n \"extra_body\": {},\n \"image_config\": {\n \"aspect_ratio\": \"<string>\",\n \"image_size\": \"<string>\"\n },\n \"extra_headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.edenai.run/v3/chat/completions")
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 \"model\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"cache_control\": {\n \"type\": \"ephemeral\",\n \"ttl\": \"<string>\"\n }\n }\n ],\n \"routing\": {\n \"sticky\": true,\n \"allow_fallbacks\": true,\n \"quality_cost\": 5,\n \"allowed_providers\": [\n \"<string>\"\n ]\n },\n \"fallbacks\": [\n \"<string>\"\n ],\n \"session_id\": \"<string>\",\n \"router_candidates\": [\n \"<string>\"\n ],\n \"pre_hooks\": [\n {}\n ],\n \"post_hooks\": [\n {}\n ],\n \"n\": 1,\n \"metadata\": {},\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 2,\n \"max_completion_tokens\": 2,\n \"modalities\": [\n \"<string>\"\n ],\n \"prediction\": {},\n \"audio\": {},\n \"presence_penalty\": 0,\n \"response_format\": {},\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {},\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {}\n ],\n \"tool_choice\": \"<string>\",\n \"parallel_tool_calls\": true,\n \"user\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"thinking\": {},\n \"web_search_options\": {},\n \"prompt_cache_key\": \"<string>\",\n \"prompt_cache_options\": {\n \"ttl\": \"30m\"\n },\n \"extra_body\": {},\n \"image_config\": {\n \"aspect_ratio\": \"<string>\",\n \"image_size\": \"<string>\"\n },\n \"extra_headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"model": "<string>",
"choices": [
{
"index": 123,
"message": {
"role": "assistant",
"content": "<string>",
"tool_calls": [
{}
],
"refusal": "<string>",
"reasoning_content": "<string>"
},
"finish_reason": "stop",
"logprobs": {}
}
],
"object": "chat.completion",
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"prompt_tokens_details": {},
"completion_tokens_details": {}
},
"system_fingerprint": "<string>",
"service_tier": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Chat Completions
OpenAI-compatible chat completions endpoint (v3).
curl --request POST \
--url https://api.edenai.run/v3/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"messages": [
{
"content": "<string>",
"cache_control": {
"type": "ephemeral",
"ttl": "<string>"
}
}
],
"routing": {
"sticky": true,
"allow_fallbacks": true,
"quality_cost": 5,
"allowed_providers": [
"<string>"
]
},
"fallbacks": [
"<string>"
],
"session_id": "<string>",
"router_candidates": [
"<string>"
],
"pre_hooks": [
{}
],
"post_hooks": [
{}
],
"n": 1,
"metadata": {},
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": false,
"top_logprobs": 10,
"max_tokens": 2,
"max_completion_tokens": 2,
"modalities": [
"<string>"
],
"prediction": {},
"audio": {},
"presence_penalty": 0,
"response_format": {},
"seed": 123,
"stop": "<string>",
"stream": false,
"stream_options": {},
"temperature": 1,
"top_p": 1,
"tools": [
{}
],
"tool_choice": "<string>",
"parallel_tool_calls": true,
"user": "<string>",
"functions": [
{}
],
"thinking": {},
"web_search_options": {},
"prompt_cache_key": "<string>",
"prompt_cache_options": {
"ttl": "30m"
},
"extra_body": {},
"image_config": {
"aspect_ratio": "<string>",
"image_size": "<string>"
},
"extra_headers": {}
}
'import requests
url = "https://api.edenai.run/v3/chat/completions"
payload = {
"model": "<string>",
"messages": [
{
"content": "<string>",
"cache_control": {
"type": "ephemeral",
"ttl": "<string>"
}
}
],
"routing": {
"sticky": True,
"allow_fallbacks": True,
"quality_cost": 5,
"allowed_providers": ["<string>"]
},
"fallbacks": ["<string>"],
"session_id": "<string>",
"router_candidates": ["<string>"],
"pre_hooks": [{}],
"post_hooks": [{}],
"n": 1,
"metadata": {},
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": False,
"top_logprobs": 10,
"max_tokens": 2,
"max_completion_tokens": 2,
"modalities": ["<string>"],
"prediction": {},
"audio": {},
"presence_penalty": 0,
"response_format": {},
"seed": 123,
"stop": "<string>",
"stream": False,
"stream_options": {},
"temperature": 1,
"top_p": 1,
"tools": [{}],
"tool_choice": "<string>",
"parallel_tool_calls": True,
"user": "<string>",
"functions": [{}],
"thinking": {},
"web_search_options": {},
"prompt_cache_key": "<string>",
"prompt_cache_options": { "ttl": "30m" },
"extra_body": {},
"image_config": {
"aspect_ratio": "<string>",
"image_size": "<string>"
},
"extra_headers": {}
}
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: '<string>',
messages: [{content: '<string>', cache_control: {type: 'ephemeral', ttl: '<string>'}}],
routing: {
sticky: true,
allow_fallbacks: true,
quality_cost: 5,
allowed_providers: ['<string>']
},
fallbacks: ['<string>'],
session_id: '<string>',
router_candidates: ['<string>'],
pre_hooks: [{}],
post_hooks: [{}],
n: 1,
metadata: {},
frequency_penalty: 0,
logit_bias: {},
logprobs: false,
top_logprobs: 10,
max_tokens: 2,
max_completion_tokens: 2,
modalities: ['<string>'],
prediction: {},
audio: {},
presence_penalty: 0,
response_format: {},
seed: 123,
stop: '<string>',
stream: false,
stream_options: {},
temperature: 1,
top_p: 1,
tools: [{}],
tool_choice: '<string>',
parallel_tool_calls: true,
user: '<string>',
functions: [{}],
thinking: {},
web_search_options: {},
prompt_cache_key: '<string>',
prompt_cache_options: {ttl: '30m'},
extra_body: {},
image_config: {aspect_ratio: '<string>', image_size: '<string>'},
extra_headers: {}
})
};
fetch('https://api.edenai.run/v3/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://api.edenai.run/v3/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([
'model' => '<string>',
'messages' => [
[
'content' => '<string>',
'cache_control' => [
'type' => 'ephemeral',
'ttl' => '<string>'
]
]
],
'routing' => [
'sticky' => true,
'allow_fallbacks' => true,
'quality_cost' => 5,
'allowed_providers' => [
'<string>'
]
],
'fallbacks' => [
'<string>'
],
'session_id' => '<string>',
'router_candidates' => [
'<string>'
],
'pre_hooks' => [
[
]
],
'post_hooks' => [
[
]
],
'n' => 1,
'metadata' => [
],
'frequency_penalty' => 0,
'logit_bias' => [
],
'logprobs' => false,
'top_logprobs' => 10,
'max_tokens' => 2,
'max_completion_tokens' => 2,
'modalities' => [
'<string>'
],
'prediction' => [
],
'audio' => [
],
'presence_penalty' => 0,
'response_format' => [
],
'seed' => 123,
'stop' => '<string>',
'stream' => false,
'stream_options' => [
],
'temperature' => 1,
'top_p' => 1,
'tools' => [
[
]
],
'tool_choice' => '<string>',
'parallel_tool_calls' => true,
'user' => '<string>',
'functions' => [
[
]
],
'thinking' => [
],
'web_search_options' => [
],
'prompt_cache_key' => '<string>',
'prompt_cache_options' => [
'ttl' => '30m'
],
'extra_body' => [
],
'image_config' => [
'aspect_ratio' => '<string>',
'image_size' => '<string>'
],
'extra_headers' => [
]
]),
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.edenai.run/v3/chat/completions"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"cache_control\": {\n \"type\": \"ephemeral\",\n \"ttl\": \"<string>\"\n }\n }\n ],\n \"routing\": {\n \"sticky\": true,\n \"allow_fallbacks\": true,\n \"quality_cost\": 5,\n \"allowed_providers\": [\n \"<string>\"\n ]\n },\n \"fallbacks\": [\n \"<string>\"\n ],\n \"session_id\": \"<string>\",\n \"router_candidates\": [\n \"<string>\"\n ],\n \"pre_hooks\": [\n {}\n ],\n \"post_hooks\": [\n {}\n ],\n \"n\": 1,\n \"metadata\": {},\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 2,\n \"max_completion_tokens\": 2,\n \"modalities\": [\n \"<string>\"\n ],\n \"prediction\": {},\n \"audio\": {},\n \"presence_penalty\": 0,\n \"response_format\": {},\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {},\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {}\n ],\n \"tool_choice\": \"<string>\",\n \"parallel_tool_calls\": true,\n \"user\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"thinking\": {},\n \"web_search_options\": {},\n \"prompt_cache_key\": \"<string>\",\n \"prompt_cache_options\": {\n \"ttl\": \"30m\"\n },\n \"extra_body\": {},\n \"image_config\": {\n \"aspect_ratio\": \"<string>\",\n \"image_size\": \"<string>\"\n },\n \"extra_headers\": {}\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.edenai.run/v3/chat/completions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"cache_control\": {\n \"type\": \"ephemeral\",\n \"ttl\": \"<string>\"\n }\n }\n ],\n \"routing\": {\n \"sticky\": true,\n \"allow_fallbacks\": true,\n \"quality_cost\": 5,\n \"allowed_providers\": [\n \"<string>\"\n ]\n },\n \"fallbacks\": [\n \"<string>\"\n ],\n \"session_id\": \"<string>\",\n \"router_candidates\": [\n \"<string>\"\n ],\n \"pre_hooks\": [\n {}\n ],\n \"post_hooks\": [\n {}\n ],\n \"n\": 1,\n \"metadata\": {},\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 2,\n \"max_completion_tokens\": 2,\n \"modalities\": [\n \"<string>\"\n ],\n \"prediction\": {},\n \"audio\": {},\n \"presence_penalty\": 0,\n \"response_format\": {},\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {},\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {}\n ],\n \"tool_choice\": \"<string>\",\n \"parallel_tool_calls\": true,\n \"user\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"thinking\": {},\n \"web_search_options\": {},\n \"prompt_cache_key\": \"<string>\",\n \"prompt_cache_options\": {\n \"ttl\": \"30m\"\n },\n \"extra_body\": {},\n \"image_config\": {\n \"aspect_ratio\": \"<string>\",\n \"image_size\": \"<string>\"\n },\n \"extra_headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.edenai.run/v3/chat/completions")
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 \"model\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"cache_control\": {\n \"type\": \"ephemeral\",\n \"ttl\": \"<string>\"\n }\n }\n ],\n \"routing\": {\n \"sticky\": true,\n \"allow_fallbacks\": true,\n \"quality_cost\": 5,\n \"allowed_providers\": [\n \"<string>\"\n ]\n },\n \"fallbacks\": [\n \"<string>\"\n ],\n \"session_id\": \"<string>\",\n \"router_candidates\": [\n \"<string>\"\n ],\n \"pre_hooks\": [\n {}\n ],\n \"post_hooks\": [\n {}\n ],\n \"n\": 1,\n \"metadata\": {},\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 10,\n \"max_tokens\": 2,\n \"max_completion_tokens\": 2,\n \"modalities\": [\n \"<string>\"\n ],\n \"prediction\": {},\n \"audio\": {},\n \"presence_penalty\": 0,\n \"response_format\": {},\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {},\n \"temperature\": 1,\n \"top_p\": 1,\n \"tools\": [\n {}\n ],\n \"tool_choice\": \"<string>\",\n \"parallel_tool_calls\": true,\n \"user\": \"<string>\",\n \"functions\": [\n {}\n ],\n \"thinking\": {},\n \"web_search_options\": {},\n \"prompt_cache_key\": \"<string>\",\n \"prompt_cache_options\": {\n \"ttl\": \"30m\"\n },\n \"extra_body\": {},\n \"image_config\": {\n \"aspect_ratio\": \"<string>\",\n \"image_size\": \"<string>\"\n },\n \"extra_headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"model": "<string>",
"choices": [
{
"index": 123,
"message": {
"role": "assistant",
"content": "<string>",
"tool_calls": [
{}
],
"refusal": "<string>",
"reasoning_content": "<string>"
},
"finish_reason": "stop",
"logprobs": {}
}
],
"object": "chat.completion",
"usage": {
"prompt_tokens": 123,
"completion_tokens": 123,
"total_tokens": 123,
"prompt_tokens_details": {},
"completion_tokens_details": {}
},
"system_fingerprint": "<string>",
"service_tier": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The name of the LLM model to use.
The messages to send to the LLM model.
Show child attributes
Show child attributes
How to pick between the providers that serve the requested model. Applies when model is a model name with no provider prefix (e.g. 'gpt-5.5'); ignored for a concrete 'provider/model' id, which already names its provider. With model='@edenai' the platform chooses the model too: quality_cost steers that choice, and the provider fields apply whenever the chosen model is a provider-less name.
Show child attributes
Show child attributes
List of fallback model IDs to try if the primary model fails. Models are tried in order. Example: ['anthropic/claude-3-opus', 'openai/gpt-4o']
3Identifies a conversation, so its requests keep reaching the provider that holds its prompt cache. Any stable string you choose — a thread id, a ticket number, an agent run. Also accepted as the x-session-id header, for clients that cannot add body fields; the body field wins if both are sent. Without one, a conversation is recognised from its opening messages instead.
256Models the '@edenai' router may choose BETWEEN — it picks the model, whereas routing picks the provider for a model you already named. Used only when model='@edenai'. Each entry is a bare model name (e.g. 'gpt-5.5' — the winner's provider is then picked like any provider-less request) or a 'provider/model' id (e.g. 'openai/gpt-5-nano' — the winner is served by that exact provider). Entries the router cannot rank are skipped and listed under edenai_metadata.routing.auto.dropped; entries naming a model already in the list collapse into its earliest spelling, which decides how the winner is returned. The request fails only when no entry is left. If not provided, the router chooses from a default pool of eligible catalog models. At most 64 entries of up to 128 characters each.
64128List of hooks to run before the LLM provider call. Each entry must have an 'action' key and optional 'params'. Example: [{'action': 'pdf_text_extract', 'params': {'method': 'default'}}]
List of hooks to run after the LLM provider call. Each entry must have an 'action' key and optional 'params'. Example: [{'action': 'json_heal', 'params': {'json_schema': {...}}}]
The number of completions to generate for each prompt. Defaults to 1.
x >= 1The reasoning effort level for the LLM model.
minimal, low, medium, high, max, xhigh, disable, none Object of metadata associated with the chat request. Can be used to provide additional context or tracking information.
Penalty for repeated tokens in the output.
-2 <= x <= 2Logit bias to influence token generation.
Show child attributes
Show child attributes
Whether to include log probabilities of tokens in the output. Defaults to False.
Number of top log probabilities to return with each token. An integer between 0 and 20.
0 <= x <= 20The maximum number of tokens to generate in the chat completion
x >= 1An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
x >= 1List of supported input/output modalities for the chat.
field for storing prediction-related information.
dictionary for audio-related parameters or metadata.
Penalty for new tokens based on their presence in the text so far.
-2 <= x <= 2Specify the desired response format for the completion.
Seed for random number generation.
'auto': Automatically select appropriate tier 'default': Use the default service tier 'flex': 50% cheaper processing with increased latency (OpenAI o3/o4-mini) 'scale' / 'priority': OpenAI scale and priority processing tiers
auto, default, flex, scale, priority Stop sequence(s) that end generation: a single string or a list of up to 4 strings.
Whether to stream the response in real-time. Defaults to False.
Options for streaming responses, such as chunk size or format.
Sampling temperature for controlling randomness in output.
0 <= x <= 2Nucleus sampling parameter for controlling diversity in output. Defaults to 1.0.
0 <= x <= 1List of tools that can be used by the model to assist in generating responses.
Specify how tools should be used. Can be 'auto', 'required', 'none', or an object to force a specific tool.
Whether to allow parallel tool calls in the completion.
User identifier for tracking or personalization purposes.
Controls function calling (legacy). The string 'none' or 'auto', or an object forcing a specific function, e.g. {'name': 'my_function'}.
none, auto List of functions that can be called by the model to assist in generating responses.
Parameters related to the model's reasoning or thinking process.
Options for web search integration. Example: json web_search_options={ "search_context_size": "medium" # Options: "low", "medium", "high" }
Hint the model to be more or less expansive in its replies. Values: "low", "medium", "high". low (gpt5 models)
low, medium, high Prompt-cache routing hint (OpenAI): requests sharing a key and a common prompt prefix are routed to the same cache shard, improving hit rates for high-volume shared prefixes. Forwarded to providers that support it, dropped elsewhere. Also read for provider stickiness when no session_id or x-session-id is given.
How long the provider retains the prompt cache — OpenAI currently accepts "in_memory" (provider default, typically 5-10 minutes) and "24h" (extended retention, supported on gpt-5.x and gpt-4.1). The known values are advertised in the schema but not enforced: the value is passed through verbatim for the provider to validate, so new provider values work without an Eden AI release. Dropped for providers that don't support it.
in_memory, 24h Request-level prompt-cache settings (mode and ttl) for OpenAI GPT-5.6 and newer models. Ignored by models that don't support prompt caching.
Show child attributes
Show child attributes
Additional parameters to pass in the request body to the provider API.
Image generation configuration for Google Gemini image models (e.g. google/gemini-2.5-flash-image).
Show child attributes
Show child attributes
Additional HTTP headers to pass to the provider API.
Show child attributes
Show child attributes
Response
Successful Response
Response body for POST /chat/completions (non-streaming).
Unique identifier for the chat completion.
Unix timestamp (seconds) when the completion was created.
Model that produced the completion.
List of completion choices generated for the request.
Show child attributes
Show child attributes
Object type. Always 'chat.completion' for this endpoint.
"chat.completion"Token usage statistics for the request.
Show child attributes
Show child attributes
Backend configuration fingerprint that produced the response.
Service tier that processed the request.