Create chat completion

curl --request POST \
  --url https://api.perceptron.inc/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "role": "system"
    }
  ],
  "model": "<string>",
  "frequency_penalty": 0,
  "max_completion_tokens": 1,
  "n": 1,
  "parallel_tool_calls": true,
  "presence_penalty": 0,
  "regex": "<string>",
  "response_format": {
    "type": "text"
  },
  "stream": false,
  "stream_options": {
    "include_usage": true
  },
  "temperature": 1,
  "tools": [
    {
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {},
        "strict": true
      },
      "type": "function"
    }
  ],
  "top_k": 1,
  "top_p": 0,
  "vision_config": {
    "enable_audio_in_video": true,
    "enable_thinking": true
  }
}
'

import requests

url = "https://api.perceptron.inc/v1/chat/completions"

payload = {
    "messages": [
        {
            "content": "<string>",
            "role": "system"
        }
    ],
    "model": "<string>",
    "frequency_penalty": 0,
    "max_completion_tokens": 1,
    "n": 1,
    "parallel_tool_calls": True,
    "presence_penalty": 0,
    "regex": "<string>",
    "response_format": { "type": "text" },
    "stream": False,
    "stream_options": { "include_usage": True },
    "temperature": 1,
    "tools": [
        {
            "function": {
                "name": "<string>",
                "description": "<string>",
                "parameters": {},
                "strict": True
            },
            "type": "function"
        }
    ],
    "top_k": 1,
    "top_p": 0,
    "vision_config": {
        "enable_audio_in_video": True,
        "enable_thinking": True
    }
}
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: 'system'}],
    model: '<string>',
    frequency_penalty: 0,
    max_completion_tokens: 1,
    n: 1,
    parallel_tool_calls: true,
    presence_penalty: 0,
    regex: '<string>',
    response_format: {type: 'text'},
    stream: false,
    stream_options: {include_usage: true},
    temperature: 1,
    tools: [
      {
        function: {name: '<string>', description: '<string>', parameters: {}, strict: true},
        type: 'function'
      }
    ],
    top_k: 1,
    top_p: 0,
    vision_config: {enable_audio_in_video: true, enable_thinking: true}
  })
};

fetch('https://api.perceptron.inc/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.perceptron.inc/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'
        ]
    ],
    'model' => '<string>',
    'frequency_penalty' => 0,
    'max_completion_tokens' => 1,
    'n' => 1,
    'parallel_tool_calls' => true,
    'presence_penalty' => 0,
    'regex' => '<string>',
    'response_format' => [
        'type' => 'text'
    ],
    'stream' => false,
    'stream_options' => [
        'include_usage' => true
    ],
    'temperature' => 1,
    'tools' => [
        [
                'function' => [
                                'name' => '<string>',
                                'description' => '<string>',
                                'parameters' => [
                                                                
                                ],
                                'strict' => true
                ],
                'type' => 'function'
        ]
    ],
    'top_k' => 1,
    'top_p' => 0,
    'vision_config' => [
        'enable_audio_in_video' => true,
        'enable_thinking' => true
    ]
  ]),
  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.perceptron.inc/v1/chat/completions"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"system\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"frequency_penalty\": 0,\n  \"max_completion_tokens\": 1,\n  \"n\": 1,\n  \"parallel_tool_calls\": true,\n  \"presence_penalty\": 0,\n  \"regex\": \"<string>\",\n  \"response_format\": {\n    \"type\": \"text\"\n  },\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"temperature\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {},\n        \"strict\": true\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"top_k\": 1,\n  \"top_p\": 0,\n  \"vision_config\": {\n    \"enable_audio_in_video\": true,\n    \"enable_thinking\": true\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://api.perceptron.inc/v1/chat/completions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"system\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"frequency_penalty\": 0,\n  \"max_completion_tokens\": 1,\n  \"n\": 1,\n  \"parallel_tool_calls\": true,\n  \"presence_penalty\": 0,\n  \"regex\": \"<string>\",\n  \"response_format\": {\n    \"type\": \"text\"\n  },\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"temperature\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {},\n        \"strict\": true\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"top_k\": 1,\n  \"top_p\": 0,\n  \"vision_config\": {\n    \"enable_audio_in_video\": true,\n    \"enable_thinking\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perceptron.inc/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\": \"system\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"frequency_penalty\": 0,\n  \"max_completion_tokens\": 1,\n  \"n\": 1,\n  \"parallel_tool_calls\": true,\n  \"presence_penalty\": 0,\n  \"regex\": \"<string>\",\n  \"response_format\": {\n    \"type\": \"text\"\n  },\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"temperature\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {},\n        \"strict\": true\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"top_k\": 1,\n  \"top_p\": 0,\n  \"vision_config\": {\n    \"enable_audio_in_video\": true,\n    \"enable_thinking\": true\n  }\n}"

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

{
  "choices": [
    {
      "index": 1,
      "message": {
        "content": "<string>",
        "role": "system",
        "reasoning_content": "<string>",
        "tool_calls": [
          {
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "type": "function"
          }
        ]
      },
      "finish_reason": "stop"
    }
  ],
  "created": 1,
  "id": "<string>",
  "model": "<string>",
  "object": "<string>",
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1,
    "prompt_tokens_details": {
      "audio_tokens": 1
    }
  }
}

POST

chat

completions

Create chat completion

curl --request POST \
  --url https://api.perceptron.inc/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "role": "system"
    }
  ],
  "model": "<string>",
  "frequency_penalty": 0,
  "max_completion_tokens": 1,
  "n": 1,
  "parallel_tool_calls": true,
  "presence_penalty": 0,
  "regex": "<string>",
  "response_format": {
    "type": "text"
  },
  "stream": false,
  "stream_options": {
    "include_usage": true
  },
  "temperature": 1,
  "tools": [
    {
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {},
        "strict": true
      },
      "type": "function"
    }
  ],
  "top_k": 1,
  "top_p": 0,
  "vision_config": {
    "enable_audio_in_video": true,
    "enable_thinking": true
  }
}
'

import requests

url = "https://api.perceptron.inc/v1/chat/completions"

payload = {
    "messages": [
        {
            "content": "<string>",
            "role": "system"
        }
    ],
    "model": "<string>",
    "frequency_penalty": 0,
    "max_completion_tokens": 1,
    "n": 1,
    "parallel_tool_calls": True,
    "presence_penalty": 0,
    "regex": "<string>",
    "response_format": { "type": "text" },
    "stream": False,
    "stream_options": { "include_usage": True },
    "temperature": 1,
    "tools": [
        {
            "function": {
                "name": "<string>",
                "description": "<string>",
                "parameters": {},
                "strict": True
            },
            "type": "function"
        }
    ],
    "top_k": 1,
    "top_p": 0,
    "vision_config": {
        "enable_audio_in_video": True,
        "enable_thinking": True
    }
}
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: 'system'}],
    model: '<string>',
    frequency_penalty: 0,
    max_completion_tokens: 1,
    n: 1,
    parallel_tool_calls: true,
    presence_penalty: 0,
    regex: '<string>',
    response_format: {type: 'text'},
    stream: false,
    stream_options: {include_usage: true},
    temperature: 1,
    tools: [
      {
        function: {name: '<string>', description: '<string>', parameters: {}, strict: true},
        type: 'function'
      }
    ],
    top_k: 1,
    top_p: 0,
    vision_config: {enable_audio_in_video: true, enable_thinking: true}
  })
};

fetch('https://api.perceptron.inc/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.perceptron.inc/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'
        ]
    ],
    'model' => '<string>',
    'frequency_penalty' => 0,
    'max_completion_tokens' => 1,
    'n' => 1,
    'parallel_tool_calls' => true,
    'presence_penalty' => 0,
    'regex' => '<string>',
    'response_format' => [
        'type' => 'text'
    ],
    'stream' => false,
    'stream_options' => [
        'include_usage' => true
    ],
    'temperature' => 1,
    'tools' => [
        [
                'function' => [
                                'name' => '<string>',
                                'description' => '<string>',
                                'parameters' => [
                                                                
                                ],
                                'strict' => true
                ],
                'type' => 'function'
        ]
    ],
    'top_k' => 1,
    'top_p' => 0,
    'vision_config' => [
        'enable_audio_in_video' => true,
        'enable_thinking' => true
    ]
  ]),
  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.perceptron.inc/v1/chat/completions"

	payload := strings.NewReader("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"system\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"frequency_penalty\": 0,\n  \"max_completion_tokens\": 1,\n  \"n\": 1,\n  \"parallel_tool_calls\": true,\n  \"presence_penalty\": 0,\n  \"regex\": \"<string>\",\n  \"response_format\": {\n    \"type\": \"text\"\n  },\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"temperature\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {},\n        \"strict\": true\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"top_k\": 1,\n  \"top_p\": 0,\n  \"vision_config\": {\n    \"enable_audio_in_video\": true,\n    \"enable_thinking\": true\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://api.perceptron.inc/v1/chat/completions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"role\": \"system\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"frequency_penalty\": 0,\n  \"max_completion_tokens\": 1,\n  \"n\": 1,\n  \"parallel_tool_calls\": true,\n  \"presence_penalty\": 0,\n  \"regex\": \"<string>\",\n  \"response_format\": {\n    \"type\": \"text\"\n  },\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"temperature\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {},\n        \"strict\": true\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"top_k\": 1,\n  \"top_p\": 0,\n  \"vision_config\": {\n    \"enable_audio_in_video\": true,\n    \"enable_thinking\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perceptron.inc/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\": \"system\"\n    }\n  ],\n  \"model\": \"<string>\",\n  \"frequency_penalty\": 0,\n  \"max_completion_tokens\": 1,\n  \"n\": 1,\n  \"parallel_tool_calls\": true,\n  \"presence_penalty\": 0,\n  \"regex\": \"<string>\",\n  \"response_format\": {\n    \"type\": \"text\"\n  },\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"temperature\": 1,\n  \"tools\": [\n    {\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {},\n        \"strict\": true\n      },\n      \"type\": \"function\"\n    }\n  ],\n  \"top_k\": 1,\n  \"top_p\": 0,\n  \"vision_config\": {\n    \"enable_audio_in_video\": true,\n    \"enable_thinking\": true\n  }\n}"

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

{
  "choices": [
    {
      "index": 1,
      "message": {
        "content": "<string>",
        "role": "system",
        "reasoning_content": "<string>",
        "tool_calls": [
          {
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "type": "function"
          }
        ]
      },
      "finish_reason": "stop"
    }
  ],
  "created": 1,
  "id": "<string>",
  "model": "<string>",
  "object": "<string>",
  "usage": {
    "completion_tokens": 1,
    "prompt_tokens": 1,
    "total_tokens": 1,
    "prompt_tokens_details": {
      "audio_tokens": 1
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication using your Perceptron API key

Body

application/json

messages

(System · object | Developer · object | User · object | Assistant · object | Tool · object)[]

required

Conversation history listed in order. Supported roles: system, developer (treated as system), user, assistant, tool.

Author role of the message: system, developer, user, assistant, or tool.

System
Developer
User
Assistant
Tool

Show child attributes

model

string

required

The model to invoke. Use GET /v1/models to discover available model IDs. New Perceptron requests should use perceptron-mk1.5.

frequency_penalty

number<float> | null

Positive values discourage the model from repeating previously used tokens.

Required range: -2 <= x <= 2

max_completion_tokens

integer<int32> | null

Maximum number of completion tokens to generate. Must fit within the selected model's context and output limits.

Required range: x >= 0

integer<int32> | null

Number of completions to generate. Only 1 is supported; greater values are rejected.

Required range: 1 <= x <= 1

parallel_tool_calls

boolean | null

Whether the model may call several functions in one turn. Defaults to true. Ignored without functions in tools.

presence_penalty

number<float> | null

Positive values encourage the model to introduce new concepts.

Required range: -2 <= x <= 2

reasoning_effort

null | enum<string>

How much the model reasons before it answers: none, minimal, low, medium or high. A tier other than none turns reasoning on. vision_config.enable_thinking, when set, decides whether the model reasons; the tier then only applies while reasoning is on.

Available options:

none,

minimal,

low,

medium,

high

regex

string | null

Regex pattern for constrained generation.

response_format

object

An object specifying the format that the model must output. Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema.

Option 1
Option 2

Show child attributes

stream

boolean | null

default:false

Set to true for SSE streaming. When omitted, the API returns a single JSON response.

stream_options

null | object

Optional streaming flags. Token usage is always reported in the final chunk of a streaming response.

Show child attributes

temperature

number<float> | null

Sampling temperature. Lower values yield deterministic replies; higher values explore more creative outputs.

Required range: 0 <= x <= 2

tool_choice

Whether the model may call the declared functions: auto (the default) or none. none is best effort and does not guarantee a response without tool calls. Forcing a call (required or a named function) is not supported and is rejected with a 400. Ignored without functions in tools.

Available options:

none,

auto,

required

tools

Function · object[] | null

Functions the model may call and the caller executes. Cannot be combined with a json_schema response_format or regex.

Functions require a model that supports tool calling: other models reject them, and tool calls or results in messages, with a 400. Generation stops at the first turn that calls functions, so a response carries at most one turn of tool_calls.

Show child attributes

top_k

integer<int32> | null

Top-k sampling. The model samples from the top k most likely tokens.

Required range: x >= 0

top_p

number<float> | null

Nucleus sampling probability. The model samples from the smallest token set whose cumulative probability exceeds this threshold.

Required range: x <= 1

vision_config

null | object

Perceptron vision-model controls (thinking, spatial output format, video audio). Only supported on Perceptron-owned models.

Show child attributes

Response

Chat completion generated successfully.

Non-streaming response body when stream=false.

choices

object[]

required

Show child attributes

created

integer<int64>

required

Required range: x >= 0

string

required

model

string

required

object

string

required

usage

null | object

Token accounting emitted with every completion.

Show child attributes

Chat Completions

Detection

Files

Models

Create chat completion

Authorizations

Body

Response