Create Chat Completion
curl --request POST \
--url https://api.intelligence.io.solutions/api/v1/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"messages": [
{
"content": "<string>",
"role": "developer",
"name": "<string>"
}
],
"model": "<string>",
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": false,
"top_logprobs": 123,
"max_tokens": 123,
"max_completion_tokens": 123,
"n": 1,
"presence_penalty": 0,
"response_format": {
"json_schema": {
"name": "<string>",
"description": "<string>",
"schema": {},
"strict": true
}
},
"seed": 123,
"stop": "<string>",
"stream": false,
"stream_options": {
"include_usage": true,
"continuous_usage_stats": false
},
"temperature": 0.7,
"top_p": 1,
"tools": [
{
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {}
},
"type": "function"
}
],
"tool_choice": "none",
"parallel_tool_calls": false,
"user": "<string>",
"best_of": 123,
"use_beam_search": false,
"top_k": -1,
"min_p": 0,
"repetition_penalty": 1,
"length_penalty": 1,
"stop_token_ids": [
123
],
"include_stop_str_in_output": false,
"ignore_eos": false,
"min_tokens": 0,
"skip_special_tokens": true,
"spaces_between_special_tokens": true,
"truncate_prompt_tokens": 2,
"prompt_logprobs": 123,
"echo": false,
"add_generation_prompt": true,
"continue_final_message": false,
"add_special_tokens": false,
"documents": [
{}
],
"chat_template": "<string>",
"chat_template_kwargs": {},
"guided_json": "<string>",
"guided_regex": "<string>",
"guided_choice": [
"<string>"
],
"guided_grammar": "<string>",
"guided_decoding_backend": "<string>",
"guided_whitespace_pattern": "<string>",
"priority": 0,
"request_id": "<string>"
}
'import requests
url = "https://api.intelligence.io.solutions/api/v1/chat/completions"
payload = {
"messages": [
{
"content": "<string>",
"role": "developer",
"name": "<string>"
}
],
"model": "<string>",
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": False,
"top_logprobs": 123,
"max_tokens": 123,
"max_completion_tokens": 123,
"n": 1,
"presence_penalty": 0,
"response_format": { "json_schema": {
"name": "<string>",
"description": "<string>",
"schema": {},
"strict": True
} },
"seed": 123,
"stop": "<string>",
"stream": False,
"stream_options": {
"include_usage": True,
"continuous_usage_stats": False
},
"temperature": 0.7,
"top_p": 1,
"tools": [
{
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {}
},
"type": "function"
}
],
"tool_choice": "none",
"parallel_tool_calls": False,
"user": "<string>",
"best_of": 123,
"use_beam_search": False,
"top_k": -1,
"min_p": 0,
"repetition_penalty": 1,
"length_penalty": 1,
"stop_token_ids": [123],
"include_stop_str_in_output": False,
"ignore_eos": False,
"min_tokens": 0,
"skip_special_tokens": True,
"spaces_between_special_tokens": True,
"truncate_prompt_tokens": 2,
"prompt_logprobs": 123,
"echo": False,
"add_generation_prompt": True,
"continue_final_message": False,
"add_special_tokens": False,
"documents": [{}],
"chat_template": "<string>",
"chat_template_kwargs": {},
"guided_json": "<string>",
"guided_regex": "<string>",
"guided_choice": ["<string>"],
"guided_grammar": "<string>",
"guided_decoding_backend": "<string>",
"guided_whitespace_pattern": "<string>",
"priority": 0,
"request_id": "<string>"
}
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({
messages: [{content: '<string>', role: 'developer', name: '<string>'}],
model: '<string>',
frequency_penalty: 0,
logit_bias: {},
logprobs: false,
top_logprobs: 123,
max_tokens: 123,
max_completion_tokens: 123,
n: 1,
presence_penalty: 0,
response_format: {
json_schema: {name: '<string>', description: '<string>', schema: {}, strict: true}
},
seed: 123,
stop: '<string>',
stream: false,
stream_options: {include_usage: true, continuous_usage_stats: false},
temperature: 0.7,
top_p: 1,
tools: [
{
function: {name: '<string>', description: '<string>', parameters: {}},
type: 'function'
}
],
tool_choice: 'none',
parallel_tool_calls: false,
user: '<string>',
best_of: 123,
use_beam_search: false,
top_k: -1,
min_p: 0,
repetition_penalty: 1,
length_penalty: 1,
stop_token_ids: [123],
include_stop_str_in_output: false,
ignore_eos: false,
min_tokens: 0,
skip_special_tokens: true,
spaces_between_special_tokens: true,
truncate_prompt_tokens: 2,
prompt_logprobs: 123,
echo: false,
add_generation_prompt: true,
continue_final_message: false,
add_special_tokens: false,
documents: [{}],
chat_template: '<string>',
chat_template_kwargs: {},
guided_json: '<string>',
guided_regex: '<string>',
guided_choice: ['<string>'],
guided_grammar: '<string>',
guided_decoding_backend: '<string>',
guided_whitespace_pattern: '<string>',
priority: 0,
request_id: '<string>'
})
};
fetch('https://api.intelligence.io.solutions/api/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://api.intelligence.io.solutions/api/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' => 'developer',
'name' => '<string>'
]
],
'model' => '<string>',
'frequency_penalty' => 0,
'logit_bias' => [
],
'logprobs' => false,
'top_logprobs' => 123,
'max_tokens' => 123,
'max_completion_tokens' => 123,
'n' => 1,
'presence_penalty' => 0,
'response_format' => [
'json_schema' => [
'name' => '<string>',
'description' => '<string>',
'schema' => [
],
'strict' => true
]
],
'seed' => 123,
'stop' => '<string>',
'stream' => false,
'stream_options' => [
'include_usage' => true,
'continuous_usage_stats' => false
],
'temperature' => 0.7,
'top_p' => 1,
'tools' => [
[
'function' => [
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
],
'type' => 'function'
]
],
'tool_choice' => 'none',
'parallel_tool_calls' => false,
'user' => '<string>',
'best_of' => 123,
'use_beam_search' => false,
'top_k' => -1,
'min_p' => 0,
'repetition_penalty' => 1,
'length_penalty' => 1,
'stop_token_ids' => [
123
],
'include_stop_str_in_output' => false,
'ignore_eos' => false,
'min_tokens' => 0,
'skip_special_tokens' => true,
'spaces_between_special_tokens' => true,
'truncate_prompt_tokens' => 2,
'prompt_logprobs' => 123,
'echo' => false,
'add_generation_prompt' => true,
'continue_final_message' => false,
'add_special_tokens' => false,
'documents' => [
[
]
],
'chat_template' => '<string>',
'chat_template_kwargs' => [
],
'guided_json' => '<string>',
'guided_regex' => '<string>',
'guided_choice' => [
'<string>'
],
'guided_grammar' => '<string>',
'guided_decoding_backend' => '<string>',
'guided_whitespace_pattern' => '<string>',
'priority' => 0,
'request_id' => '<string>'
]),
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.intelligence.io.solutions/api/v1/chat/completions"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"developer\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"<string>\",\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 123,\n \"max_tokens\": 123,\n \"max_completion_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"json_schema\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": {},\n \"strict\": true\n }\n },\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {\n \"include_usage\": true,\n \"continuous_usage_stats\": false\n },\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"tools\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n },\n \"type\": \"function\"\n }\n ],\n \"tool_choice\": \"none\",\n \"parallel_tool_calls\": false,\n \"user\": \"<string>\",\n \"best_of\": 123,\n \"use_beam_search\": false,\n \"top_k\": -1,\n \"min_p\": 0,\n \"repetition_penalty\": 1,\n \"length_penalty\": 1,\n \"stop_token_ids\": [\n 123\n ],\n \"include_stop_str_in_output\": false,\n \"ignore_eos\": false,\n \"min_tokens\": 0,\n \"skip_special_tokens\": true,\n \"spaces_between_special_tokens\": true,\n \"truncate_prompt_tokens\": 2,\n \"prompt_logprobs\": 123,\n \"echo\": false,\n \"add_generation_prompt\": true,\n \"continue_final_message\": false,\n \"add_special_tokens\": false,\n \"documents\": [\n {}\n ],\n \"chat_template\": \"<string>\",\n \"chat_template_kwargs\": {},\n \"guided_json\": \"<string>\",\n \"guided_regex\": \"<string>\",\n \"guided_choice\": [\n \"<string>\"\n ],\n \"guided_grammar\": \"<string>\",\n \"guided_decoding_backend\": \"<string>\",\n \"guided_whitespace_pattern\": \"<string>\",\n \"priority\": 0,\n \"request_id\": \"<string>\"\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.intelligence.io.solutions/api/v1/chat/completions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"developer\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"<string>\",\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 123,\n \"max_tokens\": 123,\n \"max_completion_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"json_schema\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": {},\n \"strict\": true\n }\n },\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {\n \"include_usage\": true,\n \"continuous_usage_stats\": false\n },\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"tools\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n },\n \"type\": \"function\"\n }\n ],\n \"tool_choice\": \"none\",\n \"parallel_tool_calls\": false,\n \"user\": \"<string>\",\n \"best_of\": 123,\n \"use_beam_search\": false,\n \"top_k\": -1,\n \"min_p\": 0,\n \"repetition_penalty\": 1,\n \"length_penalty\": 1,\n \"stop_token_ids\": [\n 123\n ],\n \"include_stop_str_in_output\": false,\n \"ignore_eos\": false,\n \"min_tokens\": 0,\n \"skip_special_tokens\": true,\n \"spaces_between_special_tokens\": true,\n \"truncate_prompt_tokens\": 2,\n \"prompt_logprobs\": 123,\n \"echo\": false,\n \"add_generation_prompt\": true,\n \"continue_final_message\": false,\n \"add_special_tokens\": false,\n \"documents\": [\n {}\n ],\n \"chat_template\": \"<string>\",\n \"chat_template_kwargs\": {},\n \"guided_json\": \"<string>\",\n \"guided_regex\": \"<string>\",\n \"guided_choice\": [\n \"<string>\"\n ],\n \"guided_grammar\": \"<string>\",\n \"guided_decoding_backend\": \"<string>\",\n \"guided_whitespace_pattern\": \"<string>\",\n \"priority\": 0,\n \"request_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.intelligence.io.solutions/api/v1/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 \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"developer\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"<string>\",\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 123,\n \"max_tokens\": 123,\n \"max_completion_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"json_schema\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": {},\n \"strict\": true\n }\n },\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {\n \"include_usage\": true,\n \"continuous_usage_stats\": false\n },\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"tools\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n },\n \"type\": \"function\"\n }\n ],\n \"tool_choice\": \"none\",\n \"parallel_tool_calls\": false,\n \"user\": \"<string>\",\n \"best_of\": 123,\n \"use_beam_search\": false,\n \"top_k\": -1,\n \"min_p\": 0,\n \"repetition_penalty\": 1,\n \"length_penalty\": 1,\n \"stop_token_ids\": [\n 123\n ],\n \"include_stop_str_in_output\": false,\n \"ignore_eos\": false,\n \"min_tokens\": 0,\n \"skip_special_tokens\": true,\n \"spaces_between_special_tokens\": true,\n \"truncate_prompt_tokens\": 2,\n \"prompt_logprobs\": 123,\n \"echo\": false,\n \"add_generation_prompt\": true,\n \"continue_final_message\": false,\n \"add_special_tokens\": false,\n \"documents\": [\n {}\n ],\n \"chat_template\": \"<string>\",\n \"chat_template_kwargs\": {},\n \"guided_json\": \"<string>\",\n \"guided_regex\": \"<string>\",\n \"guided_choice\": [\n \"<string>\"\n ],\n \"guided_grammar\": \"<string>\",\n \"guided_decoding_backend\": \"<string>\",\n \"guided_whitespace_pattern\": \"<string>\",\n \"priority\": 0,\n \"request_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Getting Started with AI Models API
Create Chat Completion
Creates a model response for a given chat conversation.
POST
/
api
/
v1
/
chat
/
completions
Create Chat Completion
curl --request POST \
--url https://api.intelligence.io.solutions/api/v1/chat/completions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"messages": [
{
"content": "<string>",
"role": "developer",
"name": "<string>"
}
],
"model": "<string>",
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": false,
"top_logprobs": 123,
"max_tokens": 123,
"max_completion_tokens": 123,
"n": 1,
"presence_penalty": 0,
"response_format": {
"json_schema": {
"name": "<string>",
"description": "<string>",
"schema": {},
"strict": true
}
},
"seed": 123,
"stop": "<string>",
"stream": false,
"stream_options": {
"include_usage": true,
"continuous_usage_stats": false
},
"temperature": 0.7,
"top_p": 1,
"tools": [
{
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {}
},
"type": "function"
}
],
"tool_choice": "none",
"parallel_tool_calls": false,
"user": "<string>",
"best_of": 123,
"use_beam_search": false,
"top_k": -1,
"min_p": 0,
"repetition_penalty": 1,
"length_penalty": 1,
"stop_token_ids": [
123
],
"include_stop_str_in_output": false,
"ignore_eos": false,
"min_tokens": 0,
"skip_special_tokens": true,
"spaces_between_special_tokens": true,
"truncate_prompt_tokens": 2,
"prompt_logprobs": 123,
"echo": false,
"add_generation_prompt": true,
"continue_final_message": false,
"add_special_tokens": false,
"documents": [
{}
],
"chat_template": "<string>",
"chat_template_kwargs": {},
"guided_json": "<string>",
"guided_regex": "<string>",
"guided_choice": [
"<string>"
],
"guided_grammar": "<string>",
"guided_decoding_backend": "<string>",
"guided_whitespace_pattern": "<string>",
"priority": 0,
"request_id": "<string>"
}
'import requests
url = "https://api.intelligence.io.solutions/api/v1/chat/completions"
payload = {
"messages": [
{
"content": "<string>",
"role": "developer",
"name": "<string>"
}
],
"model": "<string>",
"frequency_penalty": 0,
"logit_bias": {},
"logprobs": False,
"top_logprobs": 123,
"max_tokens": 123,
"max_completion_tokens": 123,
"n": 1,
"presence_penalty": 0,
"response_format": { "json_schema": {
"name": "<string>",
"description": "<string>",
"schema": {},
"strict": True
} },
"seed": 123,
"stop": "<string>",
"stream": False,
"stream_options": {
"include_usage": True,
"continuous_usage_stats": False
},
"temperature": 0.7,
"top_p": 1,
"tools": [
{
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {}
},
"type": "function"
}
],
"tool_choice": "none",
"parallel_tool_calls": False,
"user": "<string>",
"best_of": 123,
"use_beam_search": False,
"top_k": -1,
"min_p": 0,
"repetition_penalty": 1,
"length_penalty": 1,
"stop_token_ids": [123],
"include_stop_str_in_output": False,
"ignore_eos": False,
"min_tokens": 0,
"skip_special_tokens": True,
"spaces_between_special_tokens": True,
"truncate_prompt_tokens": 2,
"prompt_logprobs": 123,
"echo": False,
"add_generation_prompt": True,
"continue_final_message": False,
"add_special_tokens": False,
"documents": [{}],
"chat_template": "<string>",
"chat_template_kwargs": {},
"guided_json": "<string>",
"guided_regex": "<string>",
"guided_choice": ["<string>"],
"guided_grammar": "<string>",
"guided_decoding_backend": "<string>",
"guided_whitespace_pattern": "<string>",
"priority": 0,
"request_id": "<string>"
}
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({
messages: [{content: '<string>', role: 'developer', name: '<string>'}],
model: '<string>',
frequency_penalty: 0,
logit_bias: {},
logprobs: false,
top_logprobs: 123,
max_tokens: 123,
max_completion_tokens: 123,
n: 1,
presence_penalty: 0,
response_format: {
json_schema: {name: '<string>', description: '<string>', schema: {}, strict: true}
},
seed: 123,
stop: '<string>',
stream: false,
stream_options: {include_usage: true, continuous_usage_stats: false},
temperature: 0.7,
top_p: 1,
tools: [
{
function: {name: '<string>', description: '<string>', parameters: {}},
type: 'function'
}
],
tool_choice: 'none',
parallel_tool_calls: false,
user: '<string>',
best_of: 123,
use_beam_search: false,
top_k: -1,
min_p: 0,
repetition_penalty: 1,
length_penalty: 1,
stop_token_ids: [123],
include_stop_str_in_output: false,
ignore_eos: false,
min_tokens: 0,
skip_special_tokens: true,
spaces_between_special_tokens: true,
truncate_prompt_tokens: 2,
prompt_logprobs: 123,
echo: false,
add_generation_prompt: true,
continue_final_message: false,
add_special_tokens: false,
documents: [{}],
chat_template: '<string>',
chat_template_kwargs: {},
guided_json: '<string>',
guided_regex: '<string>',
guided_choice: ['<string>'],
guided_grammar: '<string>',
guided_decoding_backend: '<string>',
guided_whitespace_pattern: '<string>',
priority: 0,
request_id: '<string>'
})
};
fetch('https://api.intelligence.io.solutions/api/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://api.intelligence.io.solutions/api/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' => 'developer',
'name' => '<string>'
]
],
'model' => '<string>',
'frequency_penalty' => 0,
'logit_bias' => [
],
'logprobs' => false,
'top_logprobs' => 123,
'max_tokens' => 123,
'max_completion_tokens' => 123,
'n' => 1,
'presence_penalty' => 0,
'response_format' => [
'json_schema' => [
'name' => '<string>',
'description' => '<string>',
'schema' => [
],
'strict' => true
]
],
'seed' => 123,
'stop' => '<string>',
'stream' => false,
'stream_options' => [
'include_usage' => true,
'continuous_usage_stats' => false
],
'temperature' => 0.7,
'top_p' => 1,
'tools' => [
[
'function' => [
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
],
'type' => 'function'
]
],
'tool_choice' => 'none',
'parallel_tool_calls' => false,
'user' => '<string>',
'best_of' => 123,
'use_beam_search' => false,
'top_k' => -1,
'min_p' => 0,
'repetition_penalty' => 1,
'length_penalty' => 1,
'stop_token_ids' => [
123
],
'include_stop_str_in_output' => false,
'ignore_eos' => false,
'min_tokens' => 0,
'skip_special_tokens' => true,
'spaces_between_special_tokens' => true,
'truncate_prompt_tokens' => 2,
'prompt_logprobs' => 123,
'echo' => false,
'add_generation_prompt' => true,
'continue_final_message' => false,
'add_special_tokens' => false,
'documents' => [
[
]
],
'chat_template' => '<string>',
'chat_template_kwargs' => [
],
'guided_json' => '<string>',
'guided_regex' => '<string>',
'guided_choice' => [
'<string>'
],
'guided_grammar' => '<string>',
'guided_decoding_backend' => '<string>',
'guided_whitespace_pattern' => '<string>',
'priority' => 0,
'request_id' => '<string>'
]),
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.intelligence.io.solutions/api/v1/chat/completions"
payload := strings.NewReader("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"developer\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"<string>\",\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 123,\n \"max_tokens\": 123,\n \"max_completion_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"json_schema\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": {},\n \"strict\": true\n }\n },\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {\n \"include_usage\": true,\n \"continuous_usage_stats\": false\n },\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"tools\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n },\n \"type\": \"function\"\n }\n ],\n \"tool_choice\": \"none\",\n \"parallel_tool_calls\": false,\n \"user\": \"<string>\",\n \"best_of\": 123,\n \"use_beam_search\": false,\n \"top_k\": -1,\n \"min_p\": 0,\n \"repetition_penalty\": 1,\n \"length_penalty\": 1,\n \"stop_token_ids\": [\n 123\n ],\n \"include_stop_str_in_output\": false,\n \"ignore_eos\": false,\n \"min_tokens\": 0,\n \"skip_special_tokens\": true,\n \"spaces_between_special_tokens\": true,\n \"truncate_prompt_tokens\": 2,\n \"prompt_logprobs\": 123,\n \"echo\": false,\n \"add_generation_prompt\": true,\n \"continue_final_message\": false,\n \"add_special_tokens\": false,\n \"documents\": [\n {}\n ],\n \"chat_template\": \"<string>\",\n \"chat_template_kwargs\": {},\n \"guided_json\": \"<string>\",\n \"guided_regex\": \"<string>\",\n \"guided_choice\": [\n \"<string>\"\n ],\n \"guided_grammar\": \"<string>\",\n \"guided_decoding_backend\": \"<string>\",\n \"guided_whitespace_pattern\": \"<string>\",\n \"priority\": 0,\n \"request_id\": \"<string>\"\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.intelligence.io.solutions/api/v1/chat/completions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"developer\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"<string>\",\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 123,\n \"max_tokens\": 123,\n \"max_completion_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"json_schema\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": {},\n \"strict\": true\n }\n },\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {\n \"include_usage\": true,\n \"continuous_usage_stats\": false\n },\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"tools\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n },\n \"type\": \"function\"\n }\n ],\n \"tool_choice\": \"none\",\n \"parallel_tool_calls\": false,\n \"user\": \"<string>\",\n \"best_of\": 123,\n \"use_beam_search\": false,\n \"top_k\": -1,\n \"min_p\": 0,\n \"repetition_penalty\": 1,\n \"length_penalty\": 1,\n \"stop_token_ids\": [\n 123\n ],\n \"include_stop_str_in_output\": false,\n \"ignore_eos\": false,\n \"min_tokens\": 0,\n \"skip_special_tokens\": true,\n \"spaces_between_special_tokens\": true,\n \"truncate_prompt_tokens\": 2,\n \"prompt_logprobs\": 123,\n \"echo\": false,\n \"add_generation_prompt\": true,\n \"continue_final_message\": false,\n \"add_special_tokens\": false,\n \"documents\": [\n {}\n ],\n \"chat_template\": \"<string>\",\n \"chat_template_kwargs\": {},\n \"guided_json\": \"<string>\",\n \"guided_regex\": \"<string>\",\n \"guided_choice\": [\n \"<string>\"\n ],\n \"guided_grammar\": \"<string>\",\n \"guided_decoding_backend\": \"<string>\",\n \"guided_whitespace_pattern\": \"<string>\",\n \"priority\": 0,\n \"request_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.intelligence.io.solutions/api/v1/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 \"messages\": [\n {\n \"content\": \"<string>\",\n \"role\": \"developer\",\n \"name\": \"<string>\"\n }\n ],\n \"model\": \"<string>\",\n \"frequency_penalty\": 0,\n \"logit_bias\": {},\n \"logprobs\": false,\n \"top_logprobs\": 123,\n \"max_tokens\": 123,\n \"max_completion_tokens\": 123,\n \"n\": 1,\n \"presence_penalty\": 0,\n \"response_format\": {\n \"json_schema\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": {},\n \"strict\": true\n }\n },\n \"seed\": 123,\n \"stop\": \"<string>\",\n \"stream\": false,\n \"stream_options\": {\n \"include_usage\": true,\n \"continuous_usage_stats\": false\n },\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"tools\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n },\n \"type\": \"function\"\n }\n ],\n \"tool_choice\": \"none\",\n \"parallel_tool_calls\": false,\n \"user\": \"<string>\",\n \"best_of\": 123,\n \"use_beam_search\": false,\n \"top_k\": -1,\n \"min_p\": 0,\n \"repetition_penalty\": 1,\n \"length_penalty\": 1,\n \"stop_token_ids\": [\n 123\n ],\n \"include_stop_str_in_output\": false,\n \"ignore_eos\": false,\n \"min_tokens\": 0,\n \"skip_special_tokens\": true,\n \"spaces_between_special_tokens\": true,\n \"truncate_prompt_tokens\": 2,\n \"prompt_logprobs\": 123,\n \"echo\": false,\n \"add_generation_prompt\": true,\n \"continue_final_message\": false,\n \"add_special_tokens\": false,\n \"documents\": [\n {}\n ],\n \"chat_template\": \"<string>\",\n \"chat_template_kwargs\": {},\n \"guided_json\": \"<string>\",\n \"guided_regex\": \"<string>\",\n \"guided_choice\": [\n \"<string>\"\n ],\n \"guided_grammar\": \"<string>\",\n \"guided_decoding_backend\": \"<string>\",\n \"guided_whitespace_pattern\": \"<string>\",\n \"priority\": 0,\n \"request_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.
Authorizations
BearerAuthApiKeyAuth
io.net provided API Key, sent as Authorization: Bearer <API_KEY>.
Body
application/json
messages
(ChatCompletionDeveloperMessageParam · object | ChatCompletionSystemMessageParam · object | ChatCompletionUserMessageParam · object | ChatCompletionAssistantMessageParam · object | ChatCompletionToolMessageParam · object | ChatCompletionFunctionMessageParam · object | CustomChatCompletionMessageParam · object)[]
required
The conversation history
Minimum array length:
1- ChatCompletionDeveloperMessageParam
- ChatCompletionSystemMessageParam
- ChatCompletionUserMessageParam
- ChatCompletionAssistantMessageParam
- ChatCompletionToolMessageParam
- ChatCompletionFunctionMessageParam
- CustomChatCompletionMessageParam
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
1 <= x <= 20Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
tool_choice
Tool Choice · stringTool Choice · stringTool Choice · stringChatCompletionNamedToolChoiceParam · object
default:none
Allowed value:
"none"Required range:
x >= 1If true, the new message will be prepended with the last message if they belong to the same role.
If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.
If this is set, the chat will be formatted so that the final message in the chat is open-ended, without any EOS tokens. The model will continue this message rather than starting a new one. This allows you to "prefill" part of the model's response for it. Cannot be used at the same time as add_generation_prompt.
If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).
A list of dicts representing documents that will be accessible to the model if it is performing RAG (retrieval-augmented generation). If the template does not support RAG, this argument will have no effect. We recommend that each document should be a dict containing "title" and "text" keys.
Show child attributes
Show child attributes
A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one.
Additional kwargs to pass to the template renderer. Will be accessible by the chat template.
If specified, the output will follow the JSON schema.
If specified, the output will follow the regex pattern.
If specified, the output will be exactly one of the choices.
If specified, the output will follow the context free grammar.
If specified, will override the default guided decoding backend of the server for this specific request. If set, must be either 'outlines' / 'lm-format-enforcer'
If specified, will override the default whitespace pattern for guided json decoding.
The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.
The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response.
Response
Successful Response
Was this page helpful?