Skip to main content
POST
/
ai
/
chat
/
chat
/
completions
chat completions
curl --request POST \
  --url https://ai.pmock.com/api/ai/chat/chat/completions \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    "<unknown>"
  ],
  "stream": false,
  "temperature": 123,
  "maxTokens": 123,
  "maxCompletionTokens": 123,
  "topP": 123,
  "frequencyPenalty": 123,
  "presencePenalty": 123,
  "stop": "<unknown>",
  "n": 123,
  "seed": 123,
  "user": "<string>",
  "tools": [
    "<unknown>"
  ],
  "toolChoice": "<unknown>",
  "responseFormat": "<unknown>",
  "logprobs": true,
  "topLogprobs": 123,
  "logitBias": "<unknown>",
  "parallelToolCalls": true
}
'
{}

​
Maven

<dependency>
    <groupId>com.openai</groupId>
    <artifactId>openai-java</artifactId>
    <version>x.x.x</version>
</dependency>

​
Normal Request Example

@Test
void clientOpenClientTest() {
    OpenAIClient client = OpenAIOkHttpClient.builder()
            .apiKey(apiKey) // Your access key
            .baseUrl("https://ai.pmock.com/api/ai/chat")
            .build();

    ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
            .model("gpt-5.2")
            .addMessage(ChatCompletionMessageParam.ofSystem(
                    ChatCompletionSystemMessageParam.builder().content("You are a helpful assistant.").build()))
            .addMessage(ChatCompletionMessageParam.ofUser(
                    ChatCompletionUserMessageParam.builder().content("Hello!").build()))
            .build();

    ChatCompletion chatCompletion = client.chat().completions().create(params);
    System.out.println(chatCompletion.choices().get(0).message().content());
}

​
Normal Response

{
	"id": "chatcmpl-xxx",
	"object": "chat.completion",
	"created": 1768810259,
	"model": "gpt-5.1",
	"choices": [
		{
			"index": 0,
			"message": {
				"role": "assistant",
				"content": "Hey! How's it going?"
			},
			"finish_reason": "stop"
		}
	],
	"usage": {
		"prompt_tokens": 0,
		"completion_tokens": 0,
		"total_tokens": 0,
		"prompt_tokens_details": {
			"text_tokens": 0
		},
		"completion_tokens_details": {
			"content_tokens": 0
		}
	}
}

​
Stream Response

    @Test
void streamClientOpenClientTest() {
    OpenAIClient client = OpenAIOkHttpClient.builder()
            .apiKey(apiKey) // Your access key
            .baseUrl("https://ai.pmock.com/api/ai/chat")
            .build();

    ChatCompletionCreateParams streamParams = ChatCompletionCreateParams.builder()
            .model("gpt-5.2")
            .addMessage(ChatCompletionMessageParam.ofSystem(
                    ChatCompletionSystemMessageParam.builder().content("You are a helpful assistant.").build()))
            .addMessage(ChatCompletionMessageParam.ofUser(
                    ChatCompletionUserMessageParam.builder().content("Hello!").build()))
            .build();

    try (StreamResponse<ChatCompletionChunk> streaming = client.chat().completions().createStreaming(streamParams)) {
        streaming.stream().forEach(chunk -> {
            if (!chunk.choices().isEmpty()) {
                String content = chunk.choices().get(0).delta().content().orElse("");
                System.out.print(content);
            }
        });
    }
}

data: {"created":1768823313,"model":"gpt-5.1","id":"chatcmpl-xxx","choices":[{"delta":{"content":"?"},"index":0}],"object":"chat.completion.chunk"}
data: {"created":1768823313,"model":"gpt-5.1","id":"chatcmpl-xxx","choices":[{"delta":{},"index":0}],"object":"chat.completion.chunk"}
data: {"created":1768823313,"model":"gpt-5.1","id":"chatcmpl-xxx","choices":[{"delta":{},"finish_reason":"stop","index":0}],"object":"chat.completion.chunk"}
data: {"created":1768823316,"usage":{"completion_tokens":0,"completion_tokens_details":{},"prompt_tokens":0,"prompt_tokens_details":{},"total_tokens":0},"model":"gpt-5.1","id":"chatcmpl-xxx","choices":[{"delta":{},"index":0}],"object":"chat.completion.chunk"}
data: [DONE]

Body

application/json
​
messages
any[]
required

messages

Minimum array length: 1
​
model
enum<string>
required

model

Available options:
gpt-5.1,
gpt-5.1-all,
gpt-5.1-thinking,
gpt-5.1-thinking-all,
gpt-5.2,
gemini-3-pro,
gemini-2.5-pro,
gemini-2.5-flash,
gemini-3-flash,
claude-4.5,
gpt-5.4,
gpt-5.3,
gpt-5.3-codex,
claude-opus-4-6,
claude-haiku-4-5-20251001,
claude-sonnet-4-6,
claude-opus-4-6-max,
claude-opus-4-6-high,
claude-opus-4-6-low,
claude-opus-4-5-20251101,
claude-opus-4-5-20251101-thinking,
claude-opus-4-6-medium,
claude-opus-4-1-20250805,
claude-opus-4-20250514,
claude-opus-4-1-20250805-thinking,
claude-opus-4-7,
claude-opus-4-7-high,
claude-opus-4-7-low,
claude-opus-4-7-max,
claude-opus-4-7-medium,
claude-opus-4-7-thinking,
claude-opus-4-7-xhigh,
claude-opus-4-8,
claude-opus-4-8-high,
claude-opus-4-8-low,
claude-opus-4-8-max,
claude-opus-4-8-medium,
claude-opus-4-8-thinking,
claude-opus-4-8-xhigh,
claude-sonnet-4-20250514,
claude-sonnet-4-20250514-thinking,
claude-sonnet-4-5-20250929,
claude-sonnet-4-5-20250929-thinking
​
stream
boolean
default:false

streaming output

​
temperature
number<double>

Temperature (0-2)

​
maxTokens
integer<int32>

Maximum token count

​
maxCompletionTokens
integer<int32>

Maximum number of completed tokens

​
topP
number<double>

top P

​
frequencyPenalty
number<double>

frequency penalty(-2.0 to 2.0)

​
presencePenalty
number<double>

presence penalty(-2.0 to 2.0)

​
stop
any

Stop sequence

​
n
integer<int32>

Generated Quantity

​
seed
integer<int32>

random seed

​
user
string

user

​
tools
any[]

Tool List (Function Calling)

​
toolChoice
any

Tool selection strategy

​
responseFormat
any

Response format

​
logprobs
boolean

logprobs

​
topLogprobs
integer<int32>

top logprobs

​
logitBias
any

logit bias

​
parallelToolCalls
boolean

parallel tool calls

Response

200 - */*

OK

The response is of type object.