Documentation | Chat › Completions

Chat

chat

Chat

Completions

chat.completions

Methods

List Chat Completion Models -> { items, object }

get/v5/chat/completions/models

List Chat Completion Models

Chat Completions ->

ChatCompletion

ChatCompletionChunk

post/v5/chat/completions

Chat Completions

header Parameters

x-openai-api-key: string

Optional

Response fields

ChatCompletion

ChatCompletionChunk

Request example

curl https://api.egp.scale.com/v5/chat/completions \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{
          "messages": [
            {
              "foo": "bar"
            }
          ],
          "model": "model"
        }'

200Example

{
  "id": "id",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "message": {
        "role": "assistant",
        "annotations": [
          {
            "type": "url_citation",
            "url_citation": {
              "end_index": 0,
              "start_index": 0,
              "title": "title",
              "url": "url"
            }
          }
        ],
        "audio": {
          "id": "id",
          "data": "data",
          "expires_at": 0,
          "transcript": "transcript"
        },
        "content": "content",
        "function_call": {
          "arguments": "arguments",
          "name": "name"
        },
        "refusal": "refusal",
        "tool_calls": [
          {
            "id": "id",
            "function": {
              "arguments": "arguments",
              "name": "name"
            },
            "type": "function"
          }
        ]
      },
      "logprobs": {
        "content": [
          {
            "token": "token",
            "logprob": 0,
            "top_logprobs": [
              {
                "token": "token",
                "logprob": 0,
                "bytes": [
                  0
                ]
              }
            ],
            "bytes": [
              0
            ]
          }
        ],
        "refusal": [
          {
            "token": "token",
            "logprob": 0,
            "top_logprobs": [
              {
                "token": "token",
                "logprob": 0,
                "bytes": [
                  0
                ]
              }
            ],
            "bytes": [
              0
            ]
          }
        ]
      }
    }
  ],
  "created": 0,
  "model": "model",
  "object": "chat.completion",
  "service_tier": "auto",
  "system_fingerprint": "system_fingerprint",
  "usage": {
    "completion_tokens": 0,
    "prompt_tokens": 0,
    "total_tokens": 0,
    "completion_tokens_details": {
      "accepted_prediction_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0,
      "rejected_prediction_tokens": 0
    },
    "prompt_tokens_details": {
      "audio_tokens": 0,
      "cached_tokens": 0
    }
  }
}

Domain types

ChatCompletion = { id, choices, created, 5 more... }

ChatCompletionChunk = { id, choices, created, 5 more... }

ChatCompletionTokenLogprob = { token, logprob, top_logprobs, 1 more... }

ChoiceLogprobs = { content, refusal }

Log probability information for the choice.

CompletionCreateResponse =

ChatCompletion

ChatCompletionChunk

CompletionModelsResponse = { items, object }

InferenceModelVendor = "openai" | "cohere" | "vertex_ai" | 9 more...

ModelDefinition = { model_name, model_type, model_vendor, 1 more... }

SortOrder = "asc" | "desc"