Skip to main content
POST
/
v1
/
chat
/
completions
Create a chat completion
curl --request POST \
  --url https://alterhq.com/api/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "messages": [
    {
      "content": "<string>",
      "name": "<string>",
      "tool_call_id": "<string>"
    }
  ],
  "temperature": 1,
  "top_p": 0.5,
  "n": 2,
  "stream": true,
  "stop": "<string>",
  "max_tokens": 2,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "logit_bias": {},
  "user": "<string>",
  "tools": [
    {
      "type": "<string>",
      "function": {
        "name": "<string>",
        "parameters": {},
        "description": "<string>"
      }
    }
  ]
}
'
import requests

url = "https://alterhq.com/api/v1/chat/completions"

payload = {
    "model": "<string>",
    "messages": [
        {
            "content": "<string>",
            "name": "<string>",
            "tool_call_id": "<string>"
        }
    ],
    "temperature": 1,
    "top_p": 0.5,
    "n": 2,
    "stream": True,
    "stop": "<string>",
    "max_tokens": 2,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "logit_bias": {},
    "user": "<string>",
    "tools": [
        {
            "type": "<string>",
            "function": {
                "name": "<string>",
                "parameters": {},
                "description": "<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({
    model: '<string>',
    messages: [{content: '<string>', name: '<string>', tool_call_id: '<string>'}],
    temperature: 1,
    top_p: 0.5,
    n: 2,
    stream: true,
    stop: '<string>',
    max_tokens: 2,
    presence_penalty: 0,
    frequency_penalty: 0,
    logit_bias: {},
    user: '<string>',
    tools: [
      {
        type: '<string>',
        function: {name: '<string>', parameters: {}, description: '<string>'}
      }
    ]
  })
};

fetch('https://alterhq.com/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://alterhq.com/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([
    'model' => '<string>',
    'messages' => [
        [
                'content' => '<string>',
                'name' => '<string>',
                'tool_call_id' => '<string>'
        ]
    ],
    'temperature' => 1,
    'top_p' => 0.5,
    'n' => 2,
    'stream' => true,
    'stop' => '<string>',
    'max_tokens' => 2,
    'presence_penalty' => 0,
    'frequency_penalty' => 0,
    'logit_bias' => [
        
    ],
    'user' => '<string>',
    'tools' => [
        [
                'type' => '<string>',
                'function' => [
                                'name' => '<string>',
                                'parameters' => [
                                                                
                                ],
                                'description' => '<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://alterhq.com/api/v1/chat/completions"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"temperature\": 1,\n  \"top_p\": 0.5,\n  \"n\": 2,\n  \"stream\": true,\n  \"stop\": \"<string>\",\n  \"max_tokens\": 2,\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"logit_bias\": {},\n  \"user\": \"<string>\",\n  \"tools\": [\n    {\n      \"type\": \"<string>\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {},\n        \"description\": \"<string>\"\n      }\n    }\n  ]\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://alterhq.com/api/v1/chat/completions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"temperature\": 1,\n  \"top_p\": 0.5,\n  \"n\": 2,\n  \"stream\": true,\n  \"stop\": \"<string>\",\n  \"max_tokens\": 2,\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"logit_bias\": {},\n  \"user\": \"<string>\",\n  \"tools\": [\n    {\n      \"type\": \"<string>\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {},\n        \"description\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://alterhq.com/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  \"model\": \"<string>\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\"\n    }\n  ],\n  \"temperature\": 1,\n  \"top_p\": 0.5,\n  \"n\": 2,\n  \"stream\": true,\n  \"stop\": \"<string>\",\n  \"max_tokens\": 2,\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0,\n  \"logit_bias\": {},\n  \"user\": \"<string>\",\n  \"tools\": [\n    {\n      \"type\": \"<string>\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"parameters\": {},\n        \"description\": \"<string>\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "model": "<string>",
  "choices": [
    {
      "index": 123,
      "message": {
        "content": "<string>",
        "name": "<string>",
        "tool_call_id": "<string>"
      },
      "finish_reason": "<string>"
    }
  ],
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123
  }
}
{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token issued by the Alter macOS app.

Body

application/json
​
model
string
required
​
messages
object[]
required
​
temperature
number
Required range: 0 <= x <= 2
​
top_p
number
Required range: 0 <= x <= 1
​
n
integer
Required range: x >= 1
​
stream
boolean
​
stop
​
max_tokens
integer
Required range: x >= 1
​
presence_penalty
number
Required range: -2 <= x <= 2
​
frequency_penalty
number
Required range: -2 <= x <= 2
​
logit_bias
object
​
user
string
​
tools
object[]

Response

The chat completion response or stream.

​
id
string
required
​
object
string
required
Allowed value: "chat.completion"
​
created
integer
required
​
model
string
required
​
choices
object[]
required
​
usage
object