> ## Documentation Index > Fetch the complete documentation index at: https://openai-hd4n6.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get chat messages > Get the messages in a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned. ## OpenAPI ````yaml api-definition.yaml get /chat/completions/{completion_id}/messages openapi: 3.0.0 info: title: OpenAI API description: >- The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details. version: 2.3.0 termsOfService: https://openai.com/policies/terms-of-use contact: name: OpenAI Support url: https://help.openai.com/ license: name: MIT url: https://github.com/openai/openai-openapi/blob/master/LICENSE servers: - url: https://api.openai.com/v1 security: - ApiKeyAuth: [] tags: - name: Assistants description: Build Assistants that can call models and use tools. - name: Audio description: Turn audio into text or text into audio. - name: Chat description: >- Given a list of messages comprising a conversation, the model will return a response. - name: Completions description: >- Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. - name: Embeddings description: >- Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. - name: Evals description: Manage and run evals in the OpenAI platform. - name: Fine-tuning description: Manage fine-tuning jobs to tailor a model to your specific training data. - name: Batch description: Create large batches of API requests to run asynchronously. - name: Files description: >- Files are used to upload documents that can be used with features like Assistants and Fine-tuning. - name: Uploads description: Use Uploads to upload large files in multiple parts. - name: Images description: Given a prompt and/or an input image, the model will generate a new image. - name: Models description: List and describe the various models available in the API. - name: Moderations description: >- Given text and/or image inputs, classifies if those inputs are potentially harmful. - name: Audit Logs description: List user actions and configuration changes within this organization. paths: /chat/completions/{completion_id}/messages: get: tags: - Chat summary: Get chat messages description: | Get the messages in a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned. operationId: getChatCompletionMessages parameters: - in: path name: completion_id required: true schema: type: string description: The ID of the chat completion to retrieve messages from. - name: after in: query description: >- Identifier for the last message from the previous pagination request. required: false schema: type: string - name: limit in: query description: Number of messages to retrieve. required: false schema: type: integer default: 20 - name: order in: query description: >- Sort order for messages by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`. required: false schema: type: string enum: - asc - desc default: asc responses: '200': description: A list of messages content: application/json: schema: $ref: '#/components/schemas/ChatCompletionMessageList' components: schemas: ChatCompletionMessageList: type: object title: ChatCompletionMessageList description: | An object representing a list of chat completion messages. properties: object: type: string enum: - list default: list description: | The type of this object. It is always set to "list". x-stainless-const: true data: type: array description: | An array of chat completion message objects. items: allOf: - $ref: '#/components/schemas/ChatCompletionResponseMessage' - type: object required: - id properties: id: type: string description: The identifier of the chat message. first_id: type: string description: The identifier of the first chat message in the data array. last_id: type: string description: The identifier of the last chat message in the data array. has_more: type: boolean description: Indicates whether there are more chat messages available. required: - object - data - first_id - last_id - has_more x-oaiMeta: name: The chat completion message list object group: chat example: | { "object": "list", "data": [ { "id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0", "role": "user", "content": "write a haiku about ai", "name": null, "content_parts": null } ], "first_id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0", "last_id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2-0", "has_more": false } ChatCompletionResponseMessage: type: object description: A chat completion message generated by the model. properties: content: type: string description: The contents of the message. nullable: true refusal: type: string description: The refusal message generated by the model. nullable: true tool_calls: $ref: '#/components/schemas/ChatCompletionMessageToolCalls' annotations: type: array description: | Annotations for the message, when applicable, as when using the [web search tool](/docs/guides/tools-web-search?api-mode=chat). items: type: object description: | A URL citation when using web search. required: - type - url_citation properties: type: type: string description: The type of the URL citation. Always `url_citation`. enum: - url_citation x-stainless-const: true url_citation: type: object description: A URL citation when using web search. required: - end_index - start_index - url - title properties: end_index: type: integer description: >- The index of the last character of the URL citation in the message. start_index: type: integer description: >- The index of the first character of the URL citation in the message. url: type: string description: The URL of the web resource. title: type: string description: The title of the web resource. role: type: string enum: - assistant description: The role of the author of this message. x-stainless-const: true function_call: type: object deprecated: true description: >- Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. properties: arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. name: type: string description: The name of the function to call. required: - name - arguments audio: type: object nullable: true description: > If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](/docs/guides/audio). x-oaiExpandable: true required: - id - expires_at - data - transcript properties: id: type: string description: Unique identifier for this audio response. expires_at: type: integer description: > The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations. data: type: string description: | Base64 encoded audio bytes generated by the model, in the format specified in the request. transcript: type: string description: Transcript of the audio generated by the model. required: - role - content - refusal ChatCompletionMessageToolCalls: type: array description: The tool calls generated by the model, such as function calls. items: $ref: '#/components/schemas/ChatCompletionMessageToolCall' ChatCompletionMessageToolCall: type: object properties: id: type: string description: The ID of the tool call. type: type: string enum: - function description: The type of the tool. Currently, only `function` is supported. x-stainless-const: true function: type: object description: The function that the model called. properties: name: type: string description: The name of the function to call. arguments: type: string description: >- The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. required: - name - arguments required: - id - type - function securitySchemes: ApiKeyAuth: type: http scheme: bearer ````