API ReferenceCompletions

Create a Text Completion

Create a Text Completion

Request

Request payload.
modelstringRequired
Model identifier or alias.
promptstringRequired>=1 character

Legacy completion prompt in Human/Assistant format.

max_tokens_to_sampleintegerRequired>=1
Maximum number of tokens to sample.
metadataobject or nullOptional
Metadata object for request attribution.
stop_sequenceslist of strings or nullOptional
Stop generation if any sequence is encountered.
streambooleanOptionalDefaults to false
Whether to stream the response.
temperaturedouble or nullOptional0-1
Sampling temperature between 0 and 1.
top_kinteger or nullOptional>=0

Top-k sampling parameter.

top_pdouble or nullOptional0-1

Top-p sampling parameter.

Response

Successful Response
idstring
Completion identifier
type"completion"
Object type. Always "completion".
completionstring
Generated completion text.
stop_reasonstring or null
Reason the generation stopped.
modelstring
Resolved model identifier.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error