OpenAI Chat API

POST

/v1/chat/completions

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.mirapi.ai/v1/chat/completions"

  payload := strings.NewReader("{ \"model\": \"gpt-4\", \"messages\": [ { \"role\": \"system\", \"content\": [ { \"type\": \"text\", \"text\": \"example\", \"image_url\": { \"url\": \"example\", \"detail\": \"low\" }, \"input_audio\": { \"data\": \"example\", \"format\": \"wav\" }, \"file\": { \"filename\": \"example\", \"file_data\": \"example\", \"file_id\": \"example\" }, \"video_url\": { \"url\": \"example\" } } ], \"name\": \"example\", \"tool_calls\": [ { \"id\": \"example\", \"type\": \"function\", \"function\": { \"name\": \"example\", \"arguments\": \"example\" } } ], \"tool_call_id\": \"example\", \"reasoning_content\": \"example\" } ], \"temperature\": 1, \"top_p\": 1, \"n\": 1, \"stream\": false, \"stream_options\": { \"include_usage\": true }, \"stop\": [ \"example\" ], \"max_tokens\": 1, \"max_completion_tokens\": 1, \"presence_penalty\": 0, \"frequency_penalty\": 0, \"logit_bias\": { \"additionalProperty\": 1 }, \"user\": \"example\", \"tools\": [ { \"type\": \"function\", \"function\": { \"name\": \"example\", \"description\": \"example\", \"parameters\": {} } } ], \"tool_choice\": \"none\", \"response_format\": { \"type\": \"text\", \"json_schema\": {} }, \"seed\": 1, \"reasoning_effort\": \"low\", \"modalities\": [ \"text\" ], \"audio\": { \"voice\": \"example\", \"format\": \"example\" } }")

  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(res)
  fmt.Println(string(body))

}

const url = 'https://api.mirapi.ai/v1/chat/completions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"model":"gpt-4","messages":[{"role":"system","content":[{"type":"text","text":"example","image_url":{"url":"example","detail":"low"},"input_audio":{"data":"example","format":"wav"},"file":{"filename":"example","file_data":"example","file_id":"example"},"video_url":{"url":"example"}}],"name":"example","tool_calls":[{"id":"example","type":"function","function":{"name":"example","arguments":"example"}}],"tool_call_id":"example","reasoning_content":"example"}],"temperature":1,"top_p":1,"n":1,"stream":false,"stream_options":{"include_usage":true},"stop":["example"],"max_tokens":1,"max_completion_tokens":1,"presence_penalty":0,"frequency_penalty":0,"logit_bias":{"additionalProperty":1},"user":"example","tools":[{"type":"function","function":{"name":"example","description":"example","parameters":{}}}],"tool_choice":"none","response_format":{"type":"text","json_schema":{}},"seed":1,"reasoning_effort":"low","modalities":["text"],"audio":{"voice":"example","format":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.mirapi.ai/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "model": "gpt-4", "messages": [ { "role": "system", "content": [ { "type": "text", "text": "example", "image_url": { "url": "example", "detail": "low" }, "input_audio": { "data": "example", "format": "wav" }, "file": { "filename": "example", "file_data": "example", "file_id": "example" }, "video_url": { "url": "example" } } ], "name": "example", "tool_calls": [ { "id": "example", "type": "function", "function": { "name": "example", "arguments": "example" } } ], "tool_call_id": "example", "reasoning_content": "example" } ], "temperature": 1, "top_p": 1, "n": 1, "stream": false, "stream_options": { "include_usage": true }, "stop": [ "example" ], "max_tokens": 1, "max_completion_tokens": 1, "presence_penalty": 0, "frequency_penalty": 0, "logit_bias": { "additionalProperty": 1 }, "user": "example", "tools": [ { "type": "function", "function": { "name": "example", "description": "example", "parameters": {} } } ], "tool_choice": "none", "response_format": { "type": "text", "json_schema": {} }, "seed": 1, "reasoning_effort": "low", "modalities": [ "text" ], "audio": { "voice": "example", "format": "example" } }'

Creates a model response from the conversation history. Streaming and non-streaming responses are both supported.

Compatible with the OpenAI Chat Completions API.

Authorizations

BearerAuth

Request Body^required

application/json

object

model

required

Model ID

string

Example

gpt-4

messages

required

Conversation messages

Array<object>

object

role

required

Message role

string

Allowed values: system user assistant tool developer

content

required

One of:

string
Array<object>

string

name

Sender name

string

tool_calls

Array<object>

object

string

type

string

Example

function

function

object

name

string

arguments

string

tool_call_id

Tool call ID (for messages with the tool role)

string

reasoning_content

Reasoning content

string

temperature

Sampling temperature

number

default: 1 <= 2

top_p

Nucleus sampling (top_p)

number

default: 1 <= 1

Number of completions to generate

integer

default: 1 >= 1

stream

Whether to stream the response

boolean

stream_options

object

include_usage

boolean

stop

One of:

string
Array<string>

string

max_tokens

Maximum tokens to generate

integer

max_completion_tokens

Maximum completion tokens

integer

presence_penalty

number

0 >= -2 <= 2

frequency_penalty

number

0 >= -2 <= 2

logit_bias

object

key

additional properties

number

user

string

tools

Array<object>

object

type

string

Example

function

function

object

name

string

description

string

parameters

Parameter definition as a JSON Schema

object

tool_choice

One of:

string
object

string

Allowed values: none auto required

response_format

object

type

string

Allowed values: text json_object json_schema

json_schema

JSON Schema definition

object

seed

integer

reasoning_effort

Reasoning effort (for reasoning-capable models)

string

Allowed values: low medium high

modalities

Array<string>

Allowed values: text audio

audio

object

voice

string

format

string

Responses

200

Response created

application/json

object

string

object

string

created

integer

model

string

choices

Array<object>

object

index

integer

message

object

role

required

Message role

string

Allowed values: system user assistant tool developer

content

required

One of:

string
Array<object>

string

name

Sender name

string

tool_calls

Array<object>

object

string

type

string

function

object

name

string

arguments

string

tool_call_id

Tool call ID (for messages with the tool role)

string

reasoning_content

Reasoning content

string

finish_reason

string

Allowed values: stop length tool_calls content_filter

usage

object

prompt_tokens

Prompt tokens

integer

completion_tokens

Completion tokens

integer

total_tokens

Total tokens

integer

prompt_tokens_details

object

cached_tokens

integer

text_tokens

integer

audio_tokens

integer

image_tokens

integer

completion_tokens_details

object

text_tokens

integer

audio_tokens

integer

reasoning_tokens

integer

system_fingerprint

string

Example

{
  "object": "chat.completion",
  "choices": [
    {
      "message": {
        "role": "system",
        "content": [
          {
            "type": "text",
            "image_url": {
              "detail": "low"
            },
            "input_audio": {
              "format": "wav"
            }
          }
        ],
        "tool_calls": [
          {
            "type": "function"
          }
        ]
      },
      "finish_reason": "stop"
    }
  ]
}

400

Invalid request parameters

application/json

object

error

object

message

Error message

string

type

Error type

string

param

Related parameter

string

nullable

code

Error code

string

nullable

Example^generated

{
  "error": {
    "message": "example",
    "type": "example",
    "param": "example",
    "code": "example"
  }
}

429

Rate limited

application/json

object

error

object

message

Error message

string

type

Error type

string

param

Related parameter

string

nullable

code

Error code

string

nullable

Example^generated

{
  "error": {
    "message": "example",
    "type": "example",
    "param": "example",
    "code": "example"
  }
}

OpenAI Chat API

Authorizations

Request Bodyrequired

Example

Example

Example

Responses

200

Example

400

Examplegenerated

429

Examplegenerated

Request Body^required

Example^generated

Example^generated