Swagger Petstore - OpenAPI 3.0
POST/chat/completions/{completion_id}

Update a stored chat completion

Updates the metadata of a stored chat completion. Only chat completions created with the store parameter set to true can be modified. Currently, only the metadata field can be updated; all other fields remain immutable.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
completion_idstringrequired
The unique identifier of the chat completion to update.

Metadata update payload.

metadataobjectrequired
A set of key-value pairs to attach to the completion. Keys must be strings with a maximum length of 64 characters, and values must be strings. Pass null to clear existing metadata.

1 status code
200Returns the updated chat completion object with the new metadata applied.
idstringrequired
A unique identifier for the chat completion.
choicesarray<object>required
A list of chat completion choices. Can be more than one if `n` is greater than 1.
createdintegerrequired
The Unix timestamp (in seconds) of when the chat completion was created.
modelstringrequired
The model used for the chat completion.
metadataobjectoptional
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
service_tierstringoptional
Specifies the processing type used for serving the request. - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'. - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model. - If set to '[flex](/docs/guides/flex-processing)', then the request will be processed with the Flex Processing service tier. - To opt-in to [Fast mode](/api/docs/guides/fast-mode) at the request level, include the `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat Completions. The response will show `service_tier=priority` regardless of if you specify `service_tier=fast` or `priority` in your request. - When not set, the default behavior is 'auto'. When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.
Allowed:autodefaultflexscalepriorityfastDefault:auto
system_fingerprintstringdeprecatedoptional
This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.
objectstringrequired
The object type, which is always `chat.completion`.
Allowed:chat.completion
usageobjectoptional
Usage statistics for the completion request.
moderationobjectoptional
Moderation results for the request input and generated output, if moderated completions were requested.

Error handling

completion_id must identify an existing chat completion that was created with store set to true. metadata is required and must be a key-value object where keys are strings with a maximum length of 64 characters and values are strings.