Create chat completion

Generates a model response for the given conversation. Compatible with the OpenAI chat completions API.

POST /api/ai/chat/completions

Create chat completion

cURL

curl --request POST \
  --url https://dev.hub.oxen.ai/api/ai/chat/completions \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "name": "<string>",
      "tool_call_id": "<string>",
      "tool_calls": [
        {}
      ]
    }
  ],
  "model": "gpt-4o",
  "frequency_penalty": 123,
  "max_tokens": 123,
  "presence_penalty": 123,
  "response_format": {},
  "temperature": 123,
  "tool_choice": "<string>",
  "tools": [
    {}
  ],
  "top_p": 123
}
'

import requests

url = "https://dev.hub.oxen.ai/api/ai/chat/completions"

payload = {
    "messages": [
        {
            "content": "<string>",
            "name": "<string>",
            "tool_call_id": "<string>",
            "tool_calls": [{}]
        }
    ],
    "model": "gpt-4o",
    "frequency_penalty": 123,
    "max_tokens": 123,
    "presence_penalty": 123,
    "response_format": {},
    "temperature": 123,
    "tool_choice": "<string>",
    "tools": [{}],
    "top_p": 123
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    messages: [
      {
        content: '<string>',
        name: '<string>',
        tool_call_id: '<string>',
        tool_calls: [{}]
      }
    ],
    model: 'gpt-4o',
    frequency_penalty: 123,
    max_tokens: 123,
    presence_penalty: 123,
    response_format: {},
    temperature: 123,
    tool_choice: '<string>',
    tools: [{}],
    top_p: 123
  })
};

fetch('https://dev.hub.oxen.ai/api/ai/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://dev.hub.oxen.ai/api/ai/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>',
                'name' => '<string>',
                'tool_call_id' => '<string>',
                'tool_calls' => [
                                [
                                                                
                                ]
                ]
        ]
    ],
    'model' => 'gpt-4o',
    'frequency_penalty' => 123,
    'max_tokens' => 123,
    'presence_penalty' => 123,
    'response_format' => [
        
    ],
    'temperature' => 123,
    'tool_choice' => '<string>',
    'tools' => [
        [
                
        ]
    ],
    'top_p' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "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://dev.hub.oxen.ai/api/ai/chat/completions"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"tool_calls\": [\n        {}\n      ]\n    }\n  ],\n  \"model\": \"gpt-4o\",\n  \"frequency_penalty\": 123,\n  \"max_tokens\": 123,\n  \"presence_penalty\": 123,\n  \"response_format\": {},\n  \"temperature\": 123,\n  \"tool_choice\": \"<string>\",\n  \"tools\": [\n    {}\n  ],\n  \"top_p\": 123\n}")

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

	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://dev.hub.oxen.ai/api/ai/chat/completions")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"tool_calls\": [\n        {}\n      ]\n    }\n  ],\n  \"model\": \"gpt-4o\",\n  \"frequency_penalty\": 123,\n  \"max_tokens\": 123,\n  \"presence_penalty\": 123,\n  \"response_format\": {},\n  \"temperature\": 123,\n  \"tool_choice\": \"<string>\",\n  \"tools\": [\n    {}\n  ],\n  \"top_p\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.hub.oxen.ai/api/ai/chat/completions")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"tool_calls\": [\n        {}\n      ]\n    }\n  ],\n  \"model\": \"gpt-4o\",\n  \"frequency_penalty\": 123,\n  \"max_tokens\": 123,\n  \"presence_penalty\": 123,\n  \"response_format\": {},\n  \"temperature\": 123,\n  \"tool_choice\": \"<string>\",\n  \"tools\": [\n    {}\n  ],\n  \"top_p\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "choices": [
    {
      "finish_reason": "<string>",
      "index": 123,
      "message": {
        "content": "<string>",
        "role": "<string>",
        "tool_calls": [
          {}
        ]
      }
    }
  ],
  "created": 123,
  "id": "<string>",
  "model": "<string>",
  "object": "chat.completion",
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}

{}

Body

application/json

Chat completion request

Request to generate a chat completion. Compatible with the OpenAI chat completions API.

messages · object[] · required

Show child attributes

model · string · required

Model ID to use

Example:

"gpt-4o"

frequency_penalty · number | null

max_tokens · integer | null

presence_penalty · number | null

response_format · object | null

temperature · number | null

tool_choice · string object

tools · object[] | null

top_p · number | null

Response

200

application/json

Chat completion

choices · object[]

Show child attributes

created · integer

id · string

model · string

object · enum<string>

Available options: chat.completion

usage · object | null

Show child attributes