Create chat completions | Opik Documentation

POST/v1/private/chat/completionsCreate chat completions

Create chat completions

Request body

application/json

objectChatCompletionRequest

frequencyPenaltynumber · double

functionCallobject

Show child attributes

argumentsstring

namestring

functionsarray of object

Show child attributes

Show array items

descriptionstring

namestring

parametersobject

strictboolean

logitBiasobject

logprobsboolean

maxCompletionTokensinteger · int32

maxTokensinteger · int32

messagesarray of object

Show child attributes

Show array items

contentobjectrequired

rolestringrequired

minLength 1

metadataobject

modelstring

ninteger · int32

parallelToolCallsboolean

presencePenaltynumber · double

reasoningEffortstring

responseFormatobject

Show child attributes

jsonSchemaobject

Show child attributes

namestring

schemaobject

strictboolean

typestring

one of "text", "json_object", "json_schema"

seedinteger · int32

serviceTierstring

stoparray of string

Show child attributes

storeboolean

streamboolean

streamOptionsobject

Show child attributes

includeUsageboolean

temperaturenumber · double

toolChoiceobject

toolsarray of object

Show child attributes

Show array items

functionobjectFunction ↑

typestring

one of "function"

topLogprobsinteger · int32

topPnumber · double

userstring

Example request

{
  "frequencyPenalty": 0,
  "functionCall": {
    "arguments": "string",
    "name": "string"
  },
  "functions": [
    {
      "description": "string",
      "name": "string",
      "parameters": {
        "additionalProp1": {}
      },
      "strict": true
    }
  ],
  "logitBias": {
    "additionalProp1": 0
  },
  "logprobs": true,
  "maxCompletionTokens": 0,
  "maxTokens": 0,
  "messages": [
    {
      "content": {},
      "role": "string"
    }
  ],
  "metadata": {
    "additionalProp1": "string"
  },
  "model": "string",
  "n": 0,
  "parallelToolCalls": true,
  "presencePenalty": 0,
  "reasoningEffort": "string",
  "responseFormat": {
    "jsonSchema": {
      "name": "string",
      "schema": {
        "additionalProp1": {}
      },
      "strict": true
    },
    "type": "json_object"
  },
  "seed": 0,
  "serviceTier": "string",
  "stop": [
    "string"
  ],
  "store": true,
  "stream": true,
  "streamOptions": {
    "includeUsage": true
  },
  "temperature": 0,
  "toolChoice": {},
  "tools": [
    {
      "function": {
        "description": "string",
        "name": "string",
        "parameters": {
          "additionalProp1": {}
        },
        "strict": true
      },
      "type": "function"
    }
  ],
  "topLogprobs": 0,
  "topP": 0,
  "user": "string"
}

Responses

objectChatCompletionResponse

choicesarray of object

Show child attributes

Show array items

deltaobject

Show child attributes

contentstring

functionCallobjectFunctionCall ↑

reasoningContentstring

rolestring

toolCallsarray of object

Show child attributes

Show array items

functionobjectFunctionCall ↑

idstring

indexinteger · int32

typestring

one of "function"

finishReasonstring

indexinteger · int32

logprobsobject

Show child attributes

contentarray of object

Show child attributes

Show array items

bytesarray of integer · int32

Show child attributes

logprobnumber · double

tokenstring

messageobject

Show child attributes

contentstring

functionCallobjectFunctionCall ↑

namestring

reasoningContentstring

refusalstring

rolestring

one of "system", "user", "assistant", "tool", "function"

toolCallsarray of object

Show child attributes

Items: ToolCall ↑

createdinteger · int64

idstring

modelstring

serviceTierstring

systemFingerprintstring

usageobject

Show child attributes

completionTokensinteger · int32

completionTokensDetailsobject

Show child attributes

reasoningTokensinteger · int32

promptTokensinteger · int32

promptTokensDetailsobject

Show child attributes

cachedTokensinteger · int32

totalTokensinteger · int32

array of object

Show array items

anyOf · 2 options

Option 1objectChatCompletionResponse

choicesarray of object

Show child attributes

Items: ChatCompletionChoice ↑

createdinteger · int64

idstring

modelstring

serviceTierstring

systemFingerprintstring

usageobjectUsage ↑

Option 2objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "choices": [
    {
      "delta": {
        "content": "string",
        "functionCall": {
          "arguments": "string",
          "name": "string"
        },
        "reasoningContent": "string",
        "role": "string",
        "toolCalls": [
          {
            "function": {
              "arguments": "string",
              "name": "string"
            },
            "id": "string",
            "index": 0,
            "type": "function"
          }
        ]
      },
      "finishReason": "string",
      "index": 0,
      "logprobs": {
        "content": [
          {
            "bytes": [
              0
            ],
            "logprob": 0,
            "token": "string"
          }
        ]
      },
      "message": {
        "content": "string",
        "functionCall": {
          "arguments": "string",
          "name": "string"
        },
        "name": "string",
        "reasoningContent": "string",
        "refusal": "string",
        "role": "assistant",
        "toolCalls": [
          {
            "function": {
              "arguments": "string",
              "name": "string"
            },
            "id": "string",
            "index": 0,
            "type": "function"
          }
        ]
      }
    }
  ],
  "created": 0,
  "id": "string",
  "model": "string",
  "serviceTier": "string",
  "systemFingerprint": "string",
  "usage": {
    "completionTokens": 0,
    "completionTokensDetails": {
      "reasoningTokens": 0
    },
    "promptTokens": 0,
    "promptTokensDetails": {
      "cachedTokens": 0
    },
    "totalTokens": 0
  }
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/chat/completions' \
  -H 'Content-Type: application/json' \
  -d '{"frequencyPenalty":0,"functionCall":{"arguments":"string","name":"string"},"functions":[{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true}],"logitBias":{"additionalProp1":0},"logprobs":true,"maxCompletionTokens":0,"maxTokens":0,"messages":[{"content":{},"role":"string"}],"metadata":{"additionalProp1":"string"},"model":"string","n":0,"parallelToolCalls":true,"presencePenalty":0,"reasoningEffort":"string","responseFormat":{"jsonSchema":{"name":"string","schema":{"additionalProp1":{}},"strict":true},"type":"json_object"},"seed":0,"serviceTier":"string","stop":["string"],"store":true,"stream":true,"streamOptions":{"includeUsage":true},"temperature":0,"toolChoice":{},"tools":[{"function":{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true},"type":"function"}],"topLogprobs":0,"topP":0,"user":"string"}'

const response = await fetch('http://localhost:5173/api/v1/private/chat/completions', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"frequencyPenalty":0,"functionCall":{"arguments":"string","name":"string"},"functions":[{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true}],"logitBias":{"additionalProp1":0},"logprobs":true,"maxCompletionTokens":0,"maxTokens":0,"messages":[{"content":{},"role":"string"}],"metadata":{"additionalProp1":"string"},"model":"string","n":0,"parallelToolCalls":true,"presencePenalty":0,"reasoningEffort":"string","responseFormat":{"jsonSchema":{"name":"string","schema":{"additionalProp1":{}},"strict":true},"type":"json_object"},"seed":0,"serviceTier":"string","stop":["string"],"store":true,"stream":true,"streamOptions":{"includeUsage":true},"temperature":0,"toolChoice":{},"tools":[{"function":{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true},"type":"function"}],"topLogprobs":0,"topP":0,"user":"string"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/chat/completions', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"frequencyPenalty\":0,\"functionCall\":{\"arguments\":\"string\",\"name\":\"string\"},\"functions\":[{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true}],\"logitBias\":{\"additionalProp1\":0},\"logprobs\":true,\"maxCompletionTokens\":0,\"maxTokens\":0,\"messages\":[{\"content\":{},\"role\":\"string\"}],\"metadata\":{\"additionalProp1\":\"string\"},\"model\":\"string\",\"n\":0,\"parallelToolCalls\":true,\"presencePenalty\":0,\"reasoningEffort\":\"string\",\"responseFormat\":{\"jsonSchema\":{\"name\":\"string\",\"schema\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"json_object\"},\"seed\":0,\"serviceTier\":\"string\",\"stop\":[\"string\"],\"store\":true,\"stream\":true,\"streamOptions\":{\"includeUsage\":true},\"temperature\":0,\"toolChoice\":{},\"tools\":[{\"function\":{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"function\"}],\"topLogprobs\":0,\"topP\":0,\"user\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/chat/completions",
    headers={"Content-Type": "application/json"},
    data='{"frequencyPenalty":0,"functionCall":{"arguments":"string","name":"string"},"functions":[{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true}],"logitBias":{"additionalProp1":0},"logprobs":true,"maxCompletionTokens":0,"maxTokens":0,"messages":[{"content":{},"role":"string"}],"metadata":{"additionalProp1":"string"},"model":"string","n":0,"parallelToolCalls":true,"presencePenalty":0,"reasoningEffort":"string","responseFormat":{"jsonSchema":{"name":"string","schema":{"additionalProp1":{}},"strict":true},"type":"json_object"},"seed":0,"serviceTier":"string","stop":["string"],"store":true,"stream":true,"streamOptions":{"includeUsage":true},"temperature":0,"toolChoice":{},"tools":[{"function":{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true},"type":"function"}],"topLogprobs":0,"topP":0,"user":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"frequencyPenalty":0,"functionCall":{"arguments":"string","name":"string"},"functions":[{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true}],"logitBias":{"additionalProp1":0},"logprobs":true,"maxCompletionTokens":0,"maxTokens":0,"messages":[{"content":{},"role":"string"}],"metadata":{"additionalProp1":"string"},"model":"string","n":0,"parallelToolCalls":true,"presencePenalty":0,"reasoningEffort":"string","responseFormat":{"jsonSchema":{"name":"string","schema":{"additionalProp1":{}},"strict":true},"type":"json_object"},"seed":0,"serviceTier":"string","stop":["string"],"store":true,"stream":true,"streamOptions":{"includeUsage":true},"temperature":0,"toolChoice":{},"tools":[{"function":{"description":"string","name":"string","parameters":{"additionalProp1":{}},"strict":true},"type":"function"}],"topLogprobs":0,"topP":0,"user":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/chat/completions", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/chat/completions");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"frequencyPenalty\":0,\"functionCall\":{\"arguments\":\"string\",\"name\":\"string\"},\"functions\":[{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true}],\"logitBias\":{\"additionalProp1\":0},\"logprobs\":true,\"maxCompletionTokens\":0,\"maxTokens\":0,\"messages\":[{\"content\":{},\"role\":\"string\"}],\"metadata\":{\"additionalProp1\":\"string\"},\"model\":\"string\",\"n\":0,\"parallelToolCalls\":true,\"presencePenalty\":0,\"reasoningEffort\":\"string\",\"responseFormat\":{\"jsonSchema\":{\"name\":\"string\",\"schema\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"json_object\"},\"seed\":0,\"serviceTier\":\"string\",\"stop\":[\"string\"],\"store\":true,\"stream\":true,\"streamOptions\":{\"includeUsage\":true},\"temperature\":0,\"toolChoice\":{},\"tools\":[{\"function\":{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"function\"}],\"topLogprobs\":0,\"topP\":0,\"user\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/chat/completions"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"frequencyPenalty\":0,\"functionCall\":{\"arguments\":\"string\",\"name\":\"string\"},\"functions\":[{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true}],\"logitBias\":{\"additionalProp1\":0},\"logprobs\":true,\"maxCompletionTokens\":0,\"maxTokens\":0,\"messages\":[{\"content\":{},\"role\":\"string\"}],\"metadata\":{\"additionalProp1\":\"string\"},\"model\":\"string\",\"n\":0,\"parallelToolCalls\":true,\"presencePenalty\":0,\"reasoningEffort\":\"string\",\"responseFormat\":{\"jsonSchema\":{\"name\":\"string\",\"schema\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"json_object\"},\"seed\":0,\"serviceTier\":\"string\",\"stop\":[\"string\"],\"store\":true,\"stream\":true,\"streamOptions\":{\"includeUsage\":true},\"temperature\":0,\"toolChoice\":{},\"tools\":[{\"function\":{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"function\"}],\"topLogprobs\":0,\"topP\":0,\"user\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/chat/completions")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"frequencyPenalty\":0,\"functionCall\":{\"arguments\":\"string\",\"name\":\"string\"},\"functions\":[{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true}],\"logitBias\":{\"additionalProp1\":0},\"logprobs\":true,\"maxCompletionTokens\":0,\"maxTokens\":0,\"messages\":[{\"content\":{},\"role\":\"string\"}],\"metadata\":{\"additionalProp1\":\"string\"},\"model\":\"string\",\"n\":0,\"parallelToolCalls\":true,\"presencePenalty\":0,\"reasoningEffort\":\"string\",\"responseFormat\":{\"jsonSchema\":{\"name\":\"string\",\"schema\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"json_object\"},\"seed\":0,\"serviceTier\":\"string\",\"stop\":[\"string\"],\"store\":true,\"stream\":true,\"streamOptions\":{\"includeUsage\":true},\"temperature\":0,\"toolChoice\":{},\"tools\":[{\"function\":{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"function\"}],\"topLogprobs\":0,\"topP\":0,\"user\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/chat/completions");
request.Content = new StringContent("{\"frequencyPenalty\":0,\"functionCall\":{\"arguments\":\"string\",\"name\":\"string\"},\"functions\":[{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true}],\"logitBias\":{\"additionalProp1\":0},\"logprobs\":true,\"maxCompletionTokens\":0,\"maxTokens\":0,\"messages\":[{\"content\":{},\"role\":\"string\"}],\"metadata\":{\"additionalProp1\":\"string\"},\"model\":\"string\",\"n\":0,\"parallelToolCalls\":true,\"presencePenalty\":0,\"reasoningEffort\":\"string\",\"responseFormat\":{\"jsonSchema\":{\"name\":\"string\",\"schema\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"json_object\"},\"seed\":0,\"serviceTier\":\"string\",\"stop\":[\"string\"],\"store\":true,\"stream\":true,\"streamOptions\":{\"includeUsage\":true},\"temperature\":0,\"toolChoice\":{},\"tools\":[{\"function\":{\"description\":\"string\",\"name\":\"string\",\"parameters\":{\"additionalProp1\":{}},\"strict\":true},\"type\":\"function\"}],\"topLogprobs\":0,\"topP\":0,\"user\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "choices": [
    {
      "delta": {
        "content": "string",
        "functionCall": {
          "arguments": "string",
          "name": "string"
        },
        "reasoningContent": "string",
        "role": "string",
        "toolCalls": [
          {
            "function": {
              "arguments": "string",
              "name": "string"
            },
            "id": "string",
            "index": 0,
            "type": "function"
          }
        ]
      },
      "finishReason": "string",
      "index": 0,
      "logprobs": {
        "content": [
          {
            "bytes": [
              0
            ],
            "logprob": 0,
            "token": "string"
          }
        ]
      },
      "message": {
        "content": "string",
        "functionCall": {
          "arguments": "string",
          "name": "string"
        },
        "name": "string",
        "reasoningContent": "string",
        "refusal": "string",
        "role": "assistant",
        "toolCalls": [
          {
            "function": {
              "arguments": "string",
              "name": "string"
            },
            "id": "string",
            "index": 0,
            "type": "function"
          }
        ]
      }
    }
  ],
  "created": 0,
  "id": "string",
  "model": "string",
  "serviceTier": "string",
  "systemFingerprint": "string",
  "usage": {
    "completionTokens": 0,
    "completionTokensDetails": {
      "reasoningTokens": 0
    },
    "promptTokens": 0,
    "promptTokensDetails": {
      "cachedTokens": 0
    },
    "totalTokens": 0
  }
}