My Zuplo API

Schemas

Model

id

string · required

The model identifier

object

string · enum · required

The object type, which is always 'model'

Enum values:

model

created

integer · required

The Unix timestamp (in seconds) when the model was created

owned_by

string · required

The organization that owns the model (extracted from model ID prefix)

object

Pricing information for the model

context_length

integer

Supported context length in tokens

ModelListResponse

object

string · enum · required

The object type, which is always 'list'

Enum values:

list

object[] · required

The list of models

ChatMessage

role

string · enum · required

The role of the message author

Enum values:

system

user

assistant

tool

required

The contents of the message

name

string

An optional name for the participant

tool_call_id

string

Tool call that this message is responding to

object[]

ChatCompletionRequest

model

string · required

ID of the model to use

object[] · required

A list of messages comprising the conversation so far

temperature

number · min: 0 · max: 2

What sampling temperature to use, between 0 and 2

top_p

number · min: 0 · max: 1

An alternative to sampling with temperature

n

integer · min: 1

How many chat completion choices to generate for each input message

stream

boolean

If set, partial message deltas will be sent

Up to 4 sequences where the API will stop generating further tokens

max_tokens

integer

The maximum number of tokens to generate in the chat completion

presence_penalty

number · min: -2 · max: 2

Number between -2.0 and 2.0

frequency_penalty

number · min: -2 · max: 2

Number between -2.0 and 2.0

logit_bias

object

Modify the likelihood of specified tokens appearing in the completion

user

string

A unique identifier representing your end-user

object[]

ChatCompletionChoice

index

integer · required

The index of the choice in the list of choices

object · required

finish_reason

string · enum · required

The reason the model stopped generating tokens

Enum values:

stop

length

tool_calls

content_filter

function_call

ChatCompletionUsage

prompt_tokens

integer · required

Number of tokens in the prompt

completion_tokens

integer · required

Number of tokens in the generated completion

total_tokens

integer · required

Total number of tokens used in the request

ChatCompletionResponse

id

string · required

A unique identifier for the chat completion

object

string · enum · required

The object type, which is always 'chat.completion'

Enum values:

chat.completion

created

integer · required

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

model

string · required

The model used for the chat completion

object[] · required

A list of chat completion choices

object · required

system_fingerprint

string

This fingerprint represents the backend configuration that the model runs with

Model

id

string · required

The model identifier

object

string · enum · required

The object type, which is always 'model'

Enum values:

model

created

integer · required

The Unix timestamp (in seconds) when the model was created

owned_by

string · required

The organization that owns the model (extracted from model ID prefix)

object

Pricing information for the model

context_length

integer

Supported context length in tokens

ChatCompletionRequest

model

string · required

ID of the model to use

object[] · required

A list of messages comprising the conversation so far

temperature

number · min: 0 · max: 2

What sampling temperature to use, between 0 and 2

top_p

number · min: 0 · max: 1

An alternative to sampling with temperature

n

integer · min: 1

How many chat completion choices to generate for each input message

stream

boolean

If set, partial message deltas will be sent

Up to 4 sequences where the API will stop generating further tokens

max_tokens

integer

The maximum number of tokens to generate in the chat completion

presence_penalty

number · min: -2 · max: 2

Number between -2.0 and 2.0

frequency_penalty

number · min: -2 · max: 2

Number between -2.0 and 2.0

logit_bias

object

Modify the likelihood of specified tokens appearing in the completion

user

string

A unique identifier representing your end-user

object[]

ChatCompletionResponse

id

string · required

A unique identifier for the chat completion

object

string · enum · required

The object type, which is always 'chat.completion'

Enum values:

chat.completion

created

integer · required

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

model

string · required

The model used for the chat completion

object[] · required

A list of chat completion choices

object · required

system_fingerprint

string

This fingerprint represents the backend configuration that the model runs with