POST
/
v1
/
openai
/
chat
/
completions
curl --request POST \
  --url https://api.vlm.run/v1/openai/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "model": "vlm-1",
  "messages": [
    {
      "role": "user",
      "content": "<string>"
    }
  ],
  "max_tokens": 4096,
  "n": 123,
  "temperature": 0,
  "top_p": 1,
  "top_k": 123,
  "logprobs": 123,
  "stream": false,
  "response_format": {},
  "vlmrun": {
    "domain": "<string>",
    "config": {
      "prompt": "<string>",
      "detail": "auto",
      "json_schema": {},
      "gql_stmt": "<string>",
      "grounding": false,
      "confidence": false
    },
    "metadata": {
      "environment": "dev",
      "session_id": "<string>",
      "allow_training": true
    }
  }
}'
{
  "id": "<string>",
  "object": "chat.completion",
  "created": 123,
  "model": "<string>",
  "choices": [
    "<any>"
  ],
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123
  },
  "system_fingerprint": "<string>"
}
The OpenAI Compatibility APIs are now only available to our Pro and Enterprise users. Our SDKs have evolved to support a whole range of features with multi-modal data types that make it difficult to maintain parity with the OpenAI API. If you are still interested in using the OpenAI compatibility, please contact us.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

201
application/json
Successful Response