OpenAI Chat Completion

Create chat completion

curl --request POST \
  --url https://edgee.io/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "openai/gpt-5.2",
  "messages": [
    {
      "content": "<string>",
      "name": "<string>",
      "tool_call_id": "<string>",
      "refusal": "<string>",
      "tool_calls": [
        {
          "id": "<string>",
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          }
        }
      ],
      "cache_control": {
        "type": "ephemeral"
      }
    }
  ],
  "max_tokens": 2,
  "stream": false,
  "stream_options": {
    "include_usage": true
  },
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {}
      }
    }
  ],
  "edgee_tool_ids": [
    "edgee_current_time",
    "edgee_generate_uuid"
  ],
  "edgee_pending_id": "<string>",
  "tags": [
    "<string>"
  ],
  "enable_debug": true
}
'

import requests

url = "https://edgee.io/v1/chat/completions"

payload = {
    "model": "openai/gpt-5.2",
    "messages": [
        {
            "content": "<string>",
            "name": "<string>",
            "tool_call_id": "<string>",
            "refusal": "<string>",
            "tool_calls": [
                {
                    "id": "<string>",
                    "type": "function",
                    "function": {
                        "name": "<string>",
                        "arguments": "<string>"
                    }
                }
            ],
            "cache_control": { "type": "ephemeral" }
        }
    ],
    "max_tokens": 2,
    "stream": False,
    "stream_options": { "include_usage": True },
    "tools": [
        {
            "type": "function",
            "function": {
                "name": "<string>",
                "description": "<string>",
                "parameters": {}
            }
        }
    ],
    "edgee_tool_ids": ["edgee_current_time", "edgee_generate_uuid"],
    "edgee_pending_id": "<string>",
    "tags": ["<string>"],
    "enable_debug": 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({
    model: 'openai/gpt-5.2',
    messages: [
      {
        content: '<string>',
        name: '<string>',
        tool_call_id: '<string>',
        refusal: '<string>',
        tool_calls: [
          {
            id: '<string>',
            type: 'function',
            function: {name: '<string>', arguments: '<string>'}
          }
        ],
        cache_control: {type: 'ephemeral'}
      }
    ],
    max_tokens: 2,
    stream: false,
    stream_options: {include_usage: true},
    tools: [
      {
        type: 'function',
        function: {name: '<string>', description: '<string>', parameters: {}}
      }
    ],
    edgee_tool_ids: ['edgee_current_time', 'edgee_generate_uuid'],
    edgee_pending_id: '<string>',
    tags: ['<string>'],
    enable_debug: true
  })
};

fetch('https://edgee.io/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://edgee.io/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' => 'openai/gpt-5.2',
    'messages' => [
        [
                'content' => '<string>',
                'name' => '<string>',
                'tool_call_id' => '<string>',
                'refusal' => '<string>',
                'tool_calls' => [
                                [
                                                                'id' => '<string>',
                                                                'type' => 'function',
                                                                'function' => [
                                                                                                                                'name' => '<string>',
                                                                                                                                'arguments' => '<string>'
                                                                ]
                                ]
                ],
                'cache_control' => [
                                'type' => 'ephemeral'
                ]
        ]
    ],
    'max_tokens' => 2,
    'stream' => false,
    'stream_options' => [
        'include_usage' => true
    ],
    'tools' => [
        [
                'type' => 'function',
                'function' => [
                                'name' => '<string>',
                                'description' => '<string>',
                                'parameters' => [
                                                                
                                ]
                ]
        ]
    ],
    'edgee_tool_ids' => [
        'edgee_current_time',
        'edgee_generate_uuid'
    ],
    'edgee_pending_id' => '<string>',
    'tags' => [
        '<string>'
    ],
    'enable_debug' => 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://edgee.io/v1/chat/completions"

	payload := strings.NewReader("{\n  \"model\": \"openai/gpt-5.2\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"refusal\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"cache_control\": {\n        \"type\": \"ephemeral\"\n      }\n    }\n  ],\n  \"max_tokens\": 2,\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {}\n      }\n    }\n  ],\n  \"edgee_tool_ids\": [\n    \"edgee_current_time\",\n    \"edgee_generate_uuid\"\n  ],\n  \"edgee_pending_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"enable_debug\": true\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://edgee.io/v1/chat/completions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"openai/gpt-5.2\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"refusal\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"cache_control\": {\n        \"type\": \"ephemeral\"\n      }\n    }\n  ],\n  \"max_tokens\": 2,\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {}\n      }\n    }\n  ],\n  \"edgee_tool_ids\": [\n    \"edgee_current_time\",\n    \"edgee_generate_uuid\"\n  ],\n  \"edgee_pending_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"enable_debug\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edgee.io/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\": \"openai/gpt-5.2\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"refusal\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"cache_control\": {\n        \"type\": \"ephemeral\"\n      }\n    }\n  ],\n  \"max_tokens\": 2,\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {}\n      }\n    }\n  ],\n  \"edgee_tool_ids\": [\n    \"edgee_current_time\",\n    \"edgee_generate_uuid\"\n  ],\n  \"edgee_pending_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"enable_debug\": true\n}"

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

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "openai/gpt-5.2",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 10,
    "total_tokens": 20,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens_details": {
      "reasoning_tokens": 0
    }
  },
  "compression": {
    "saved_tokens": 450,
    "cost_savings": 27000,
    "reduction": 48.99884991374353,
    "time_ms": 12
  }
}

POST

chat

completions

Create chat completion

curl --request POST \
  --url https://edgee.io/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "openai/gpt-5.2",
  "messages": [
    {
      "content": "<string>",
      "name": "<string>",
      "tool_call_id": "<string>",
      "refusal": "<string>",
      "tool_calls": [
        {
          "id": "<string>",
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          }
        }
      ],
      "cache_control": {
        "type": "ephemeral"
      }
    }
  ],
  "max_tokens": 2,
  "stream": false,
  "stream_options": {
    "include_usage": true
  },
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {}
      }
    }
  ],
  "edgee_tool_ids": [
    "edgee_current_time",
    "edgee_generate_uuid"
  ],
  "edgee_pending_id": "<string>",
  "tags": [
    "<string>"
  ],
  "enable_debug": true
}
'

import requests

url = "https://edgee.io/v1/chat/completions"

payload = {
    "model": "openai/gpt-5.2",
    "messages": [
        {
            "content": "<string>",
            "name": "<string>",
            "tool_call_id": "<string>",
            "refusal": "<string>",
            "tool_calls": [
                {
                    "id": "<string>",
                    "type": "function",
                    "function": {
                        "name": "<string>",
                        "arguments": "<string>"
                    }
                }
            ],
            "cache_control": { "type": "ephemeral" }
        }
    ],
    "max_tokens": 2,
    "stream": False,
    "stream_options": { "include_usage": True },
    "tools": [
        {
            "type": "function",
            "function": {
                "name": "<string>",
                "description": "<string>",
                "parameters": {}
            }
        }
    ],
    "edgee_tool_ids": ["edgee_current_time", "edgee_generate_uuid"],
    "edgee_pending_id": "<string>",
    "tags": ["<string>"],
    "enable_debug": 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({
    model: 'openai/gpt-5.2',
    messages: [
      {
        content: '<string>',
        name: '<string>',
        tool_call_id: '<string>',
        refusal: '<string>',
        tool_calls: [
          {
            id: '<string>',
            type: 'function',
            function: {name: '<string>', arguments: '<string>'}
          }
        ],
        cache_control: {type: 'ephemeral'}
      }
    ],
    max_tokens: 2,
    stream: false,
    stream_options: {include_usage: true},
    tools: [
      {
        type: 'function',
        function: {name: '<string>', description: '<string>', parameters: {}}
      }
    ],
    edgee_tool_ids: ['edgee_current_time', 'edgee_generate_uuid'],
    edgee_pending_id: '<string>',
    tags: ['<string>'],
    enable_debug: true
  })
};

fetch('https://edgee.io/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://edgee.io/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' => 'openai/gpt-5.2',
    'messages' => [
        [
                'content' => '<string>',
                'name' => '<string>',
                'tool_call_id' => '<string>',
                'refusal' => '<string>',
                'tool_calls' => [
                                [
                                                                'id' => '<string>',
                                                                'type' => 'function',
                                                                'function' => [
                                                                                                                                'name' => '<string>',
                                                                                                                                'arguments' => '<string>'
                                                                ]
                                ]
                ],
                'cache_control' => [
                                'type' => 'ephemeral'
                ]
        ]
    ],
    'max_tokens' => 2,
    'stream' => false,
    'stream_options' => [
        'include_usage' => true
    ],
    'tools' => [
        [
                'type' => 'function',
                'function' => [
                                'name' => '<string>',
                                'description' => '<string>',
                                'parameters' => [
                                                                
                                ]
                ]
        ]
    ],
    'edgee_tool_ids' => [
        'edgee_current_time',
        'edgee_generate_uuid'
    ],
    'edgee_pending_id' => '<string>',
    'tags' => [
        '<string>'
    ],
    'enable_debug' => 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://edgee.io/v1/chat/completions"

	payload := strings.NewReader("{\n  \"model\": \"openai/gpt-5.2\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"refusal\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"cache_control\": {\n        \"type\": \"ephemeral\"\n      }\n    }\n  ],\n  \"max_tokens\": 2,\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {}\n      }\n    }\n  ],\n  \"edgee_tool_ids\": [\n    \"edgee_current_time\",\n    \"edgee_generate_uuid\"\n  ],\n  \"edgee_pending_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"enable_debug\": true\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://edgee.io/v1/chat/completions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"openai/gpt-5.2\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"refusal\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"cache_control\": {\n        \"type\": \"ephemeral\"\n      }\n    }\n  ],\n  \"max_tokens\": 2,\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {}\n      }\n    }\n  ],\n  \"edgee_tool_ids\": [\n    \"edgee_current_time\",\n    \"edgee_generate_uuid\"\n  ],\n  \"edgee_pending_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"enable_debug\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edgee.io/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\": \"openai/gpt-5.2\",\n  \"messages\": [\n    {\n      \"content\": \"<string>\",\n      \"name\": \"<string>\",\n      \"tool_call_id\": \"<string>\",\n      \"refusal\": \"<string>\",\n      \"tool_calls\": [\n        {\n          \"id\": \"<string>\",\n          \"type\": \"function\",\n          \"function\": {\n            \"name\": \"<string>\",\n            \"arguments\": \"<string>\"\n          }\n        }\n      ],\n      \"cache_control\": {\n        \"type\": \"ephemeral\"\n      }\n    }\n  ],\n  \"max_tokens\": 2,\n  \"stream\": false,\n  \"stream_options\": {\n    \"include_usage\": true\n  },\n  \"tools\": [\n    {\n      \"type\": \"function\",\n      \"function\": {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\",\n        \"parameters\": {}\n      }\n    }\n  ],\n  \"edgee_tool_ids\": [\n    \"edgee_current_time\",\n    \"edgee_generate_uuid\"\n  ],\n  \"edgee_pending_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"enable_debug\": true\n}"

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

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "openai/gpt-5.2",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 10,
    "total_tokens": 20,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens_details": {
      "reasoning_tokens": 0
    }
  },
  "compression": {
    "saved_tokens": 450,
    "cost_savings": 27000,
    "reduction": 48.99884991374353,
    "time_ms": 12
  }
}

Creates a completion for the chat message. The Edgee API is OpenAI-compatible and works with any model and provider. Supports both streaming and non-streaming responses.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your API key. More info here

Headers

X-Edgee-Tags

string

Comma-separated list of tags for categorizing and filtering requests in analytics and logs. Example: production,chatbot,customer-support

X-Edgee-Debug

boolean

Enable debug mode to include additional debugging information in the response.

X-Edgee-Compression-Model

enum<string>

Compression bundle to apply. Tunes the compressor for the agentic style of the calling client.

Available options:

claude,

opencode,

cursor,

codex

Body

application/json

model

string

required

ID of the model to use. Format: {author_id}/{model_id} (e.g. openai/gpt-5.2)

Example:

"openai/gpt-5.2"

messages

object[]

required

A list of messages comprising the conversation so far.

Minimum array length: 1

Show child attributes

max_tokens

integer

The maximum number of tokens that can be generated in the chat completion.

Required range: x >= 1

stream

boolean

default:false

If set, partial message deltas will be sent, as in OpenAI. Streamed chunks are sent as Server-Sent Events (SSE).

stream_options

object

Options for streaming response.

Show child attributes

tools

object[]

A list of tools the model may call. Currently, only function type is supported.

Show child attributes

tool_choice

Controls which tool (if any) the model is allowed to call. Accepts a bare string (none / auto), a typed-mode object ({ "type": "auto" | "none" }), or a specific function reference.

Available options:

none,

auto

edgee_tool_ids

string[]

List of Edge Tool IDs to inject (e.g. edgee_current_time, edgee_generate_uuid). Each ID must be activated for your API key. When omitted or empty, only tools with hydration enabled for your org or API key are auto-injected. Invalid or non-activated IDs return 400 with invalid_edgee_tool_ids.

Example:

["edgee_current_time", "edgee_generate_uuid"]

edgee_pending_id

string

Pending operation ID when continuing a conversation after Edge Tool execution (e.g. when mixing client-side and Edge Tools). The gateway injects stored Edge Tool results into the message history.

Response

Chat completion created successfully

string

required

A unique identifier for the chat completion.

Example:

"chatcmpl-123"

object

enum<string>

required

The object type, which is always chat.completion.

Available options:

chat.completion

created

integer

required

The Unix timestamp (in seconds) of when the chat completion was created.

Example:

1677652288

model

string

required

The model used for the chat completion.

Example:

"openai/gpt-5.2"

choices

object[]

required

A list of chat completion choices. Can be more than one if n is greater than 1.

Show child attributes

usage

object

required

Usage statistics for the completion. In streaming responses, this is only present in the final chunk when stream_options.include_usage is true.

Show child attributes

compression

object

Token compression metrics. Present in the response when token compression was applied to the request. The usage.prompt_tokens field reflects the compressed token count actually billed by the provider.

Show child attributes

edgee_pending_id

string

Present when one or more Edge Tool calls were deferred. Pass this value back as edgee_pending_id in the next request to resume the conversation with the tool results filled in.

edgee_tools_executed

object[]

List of Edge Tools the gateway executed inline before returning. Empty or absent when no Edge Tools ran.

Show child attributes

Errors

OpenAI Responses

⌘I

Gateway API

Console API

Authorizations

Headers

Body

Response