Container Responses Chunk Object

event: response.created
data: {
  "type": "response.created",
  "sequence_number": 0,
  "response": {
    "id": "resp_4b71d12c86d94e719c7e3984a7bb7941",
    "object": "response",
    "created_at": 1735722153,
    "status": "in_progress",
    "output": []
  }
}

event: response.in_progress
data: {
  "type": "response.in_progress",
  "sequence_number": 1,
  "response": {
    "id": "resp_4b71d12c86d94e719c7e3984a7bb7941",
    "object": "response",
    "created_at": 1735722153,
    "status": "in_progress",
    "output": []
  }
}

event: response.output_item.added
data: {
  "type": "response.output_item.added",
  "sequence_number": 2,
  "output_index": 0,
  "item": {
    "id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
    "type": "message",
    "status": "in_progress",
    "role": "assistant",
    "content": []
  }
}

event: response.content_part.added
data: {
  "type": "response.content_part.added",
  "sequence_number": 3,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "part": { "type": "output_text", "text": "" }
}

event: response.output_text.delta
data: {
  "type": "response.output_text.delta",
  "sequence_number": 4,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "delta": "Hello"
}

...

event: response.output_text.done
data: {
  "type": "response.output_text.done",
  "sequence_number": 6,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "text": "Hello there, how may I assist you today?"
}

event: response.content_part.done
data: {
  "type": "response.content_part.done",
  "sequence_number": 7,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "part": {
    "type": "output_text",
    "text": "Hello there, how may I assist you today?"
  }
}

event: response.output_item.done
data: {
  "type": "response.output_item.done",
  "sequence_number": 8,
  "output_index": 0,
  "item": {
    "id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
    "type": "message",
    "status": "completed",
    "role": "assistant",
    "content": [
      {
        "type": "output_text",
        "text": "Hello there, how may I assist you today?"
      }
    ]
  }
}

event: response.completed
data: {
  "type": "response.completed",
  "sequence_number": 9,
  "response": {
    "id": "resp_4b71d12c86d94e719c7e3984a7bb7941",
    "object": "response",
    "created_at": 1735722153,
    "status": "completed",
    "output": [
      {
        "id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
        "type": "message",
        "status": "completed",
        "role": "assistant",
        "content": [
          {
            "type": "output_text",
            "text": "Hello there, how may I assist you today?"
          }
        ]
      }
    ],
    "usage": {
      "input_tokens": 9,
      "input_tokens_details": { "cached_tokens": 0 },
      "output_tokens": 11,
      "output_tokens_details": { "reasoning_tokens": 0 },
      "total_tokens": 20
    }
  }
}

Represents a streamed chunk returned when streaming the responses API, based on the provided input.

event: response.created
data: {
  "type": "response.created",
  "sequence_number": 0,
  "response": {
    "id": "resp_4b71d12c86d94e719c7e3984a7bb7941",
    "object": "response",
    "created_at": 1735722153,
    "status": "in_progress",
    "output": []
  }
}

event: response.in_progress
data: {
  "type": "response.in_progress",
  "sequence_number": 1,
  "response": {
    "id": "resp_4b71d12c86d94e719c7e3984a7bb7941",
    "object": "response",
    "created_at": 1735722153,
    "status": "in_progress",
    "output": []
  }
}

event: response.output_item.added
data: {
  "type": "response.output_item.added",
  "sequence_number": 2,
  "output_index": 0,
  "item": {
    "id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
    "type": "message",
    "status": "in_progress",
    "role": "assistant",
    "content": []
  }
}

event: response.content_part.added
data: {
  "type": "response.content_part.added",
  "sequence_number": 3,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "part": { "type": "output_text", "text": "" }
}

event: response.output_text.delta
data: {
  "type": "response.output_text.delta",
  "sequence_number": 4,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "delta": "Hello"
}

...

event: response.output_text.done
data: {
  "type": "response.output_text.done",
  "sequence_number": 6,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "text": "Hello there, how may I assist you today?"
}

event: response.content_part.done
data: {
  "type": "response.content_part.done",
  "sequence_number": 7,
  "item_id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
  "output_index": 0,
  "content_index": 0,
  "part": {
    "type": "output_text",
    "text": "Hello there, how may I assist you today?"
  }
}

event: response.output_item.done
data: {
  "type": "response.output_item.done",
  "sequence_number": 8,
  "output_index": 0,
  "item": {
    "id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
    "type": "message",
    "status": "completed",
    "role": "assistant",
    "content": [
      {
        "type": "output_text",
        "text": "Hello there, how may I assist you today?"
      }
    ]
  }
}

event: response.completed
data: {
  "type": "response.completed",
  "sequence_number": 9,
  "response": {
    "id": "resp_4b71d12c86d94e719c7e3984a7bb7941",
    "object": "response",
    "created_at": 1735722153,
    "status": "completed",
    "output": [
      {
        "id": "msg_4b71d12c86d94e719c7e3984a7bb7941",
        "type": "message",
        "status": "completed",
        "role": "assistant",
        "content": [
          {
            "type": "output_text",
            "text": "Hello there, how may I assist you today?"
          }
        ]
      }
    ],
    "usage": {
      "input_tokens": 9,
      "input_tokens_details": { "cached_tokens": 0 },
      "output_tokens": 11,
      "output_tokens_details": { "reasoning_tokens": 0 },
      "total_tokens": 20
    }
  }
}

Events

`event: response.created` chunk object

string

required

The type of the event. Always response.created.

object

required

The response that was created.

Show child attributes

string

required

Unique identifier for this response.

string

required

The object type of this resource - always set to response.

integer

required

Unix timestamp (in seconds) of when this response was created.

enum<string>

required

The status of the response generation. One of completed, failed, in_progress, or incomplete.Available options: in_progress, completed, incomplete, failed

object[]

required

An array of content items generated by the model.The length and order of items in the output array are dependent on the model’s response.

object | null

Token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Show child attributes

integer

required

The number of input tokens.

object

required

A detailed breakdown of the input tokens.

Show child attributes

integer

required

The number of tokens that were retrieved from the cache.

integer

required

The number of output tokens.

object

required

A detailed breakdown of the output tokens.

Show child attributes

integer

required

The number of reasoning tokens.

integer

required

The total number of tokens used.

object | null

Details about why the response is incomplete.

Show child attributes

enum<string>

The reason why the response is incomplete.Available options: max_output_tokens, content_filter

string | null

The model used to generate the response.

integer

required

The sequence number for this event.

`event: response.in_progress` chunk object

string

required

The type of the event. Always response.in_progress.

object

required

The response that is in progress.

Show child attributes

string

required

Unique identifier for this response.

string

required

The object type of this resource - always set to response.

integer

required

Unix timestamp (in seconds) of when this response was created.

enum<string>

required

The status of the response generation. One of completed, failed, in_progress, or incomplete.Available options: in_progress, completed, incomplete, failed

object[]

required

An array of content items generated by the model.The length and order of items in the output array are dependent on the model’s response.

object | null

Token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Show child attributes

integer

required

The number of input tokens.

object

required

A detailed breakdown of the input tokens.

Show child attributes

integer

required

The number of tokens that were retrieved from the cache.

integer

required

The number of output tokens.

object

required

A detailed breakdown of the output tokens.

Show child attributes

integer

required

The number of reasoning tokens.

integer

required

The total number of tokens used.

object | null

Details about why the response is incomplete.

Show child attributes

enum<string>

The reason why the response is incomplete.Available options: max_output_tokens, content_filter

string | null

The model used to generate the response.

integer

required

The sequence number of this event.

`event: response.completed` chunk object

string

required

The type of the event. Always response.completed.

object

required

Properties of the completed response.

Show child attributes

string

required

Unique identifier for this response.

string

required

The object type of this resource - always set to response.

integer

required

Unix timestamp (in seconds) of when this response was created.

enum<string>

required

The status of the response generation. One of completed, failed, in_progress, or incomplete.Available options: in_progress, completed, incomplete, failed

object[]

required

An array of content items generated by the model.The length and order of items in the output array are dependent on the model’s response.

object | null

Token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Show child attributes

integer

required

The number of input tokens.

object

required

A detailed breakdown of the input tokens.

Show child attributes

integer

required

The number of tokens that were retrieved from the cache.

integer

required

The number of output tokens.

object

required

A detailed breakdown of the output tokens.

Show child attributes

integer

required

The number of reasoning tokens.

integer

required

The total number of tokens used.

object | null

Details about why the response is incomplete.

Show child attributes

enum<string>

The reason why the response is incomplete.Available options: max_output_tokens, content_filter

string | null

The model used to generate the response.

integer

required

The sequence number for this event.

`event: response.failed` chunk object

string

required

The type of the event. Always response.failed.

object

required

The response that failed.

Show child attributes

string

required

Unique identifier for this response.

string

required

The object type of this resource - always set to response.

integer

required

Unix timestamp (in seconds) of when this response was created.

enum<string>

required

The status of the response generation. One of completed, failed, in_progress, or incomplete.Available options: in_progress, completed, incomplete, failed

object[]

required

An array of content items generated by the model.The length and order of items in the output array are dependent on the model’s response.

object | null

Token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Show child attributes

integer

required

The number of input tokens.

object

required

A detailed breakdown of the input tokens.

Show child attributes

integer

required

The number of tokens that were retrieved from the cache.

integer

required

The number of output tokens.

object

required

A detailed breakdown of the output tokens.

Show child attributes

integer

required

The number of reasoning tokens.

integer

required

The total number of tokens used.

object | null

Details about why the response is incomplete.

Show child attributes

enum<string>

The reason why the response is incomplete.Available options: max_output_tokens, content_filter

string | null

The model used to generate the response.

integer

required

The sequence number of this event.

`event: response.incomplete` chunk object

string

required

The type of the event. Always response.incomplete.

object

required

The response that was incomplete.

Show child attributes

string

required

Unique identifier for this response.

string

required

The object type of this resource - always set to response.

integer

required

Unix timestamp (in seconds) of when this response was created.

enum<string>

required

The status of the response generation. One of completed, failed, in_progress, or incomplete.Available options: in_progress, completed, incomplete, failed

object[]

required

An array of content items generated by the model.The length and order of items in the output array are dependent on the model’s response.

object | null

Token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used.

Show child attributes

integer

required

The number of input tokens.

object

required

A detailed breakdown of the input tokens.

Show child attributes

integer

required

The number of tokens that were retrieved from the cache.

integer

required

The number of output tokens.

object

required

A detailed breakdown of the output tokens.

Show child attributes

integer

required

The number of reasoning tokens.

integer

required

The total number of tokens used.

object | null

Details about why the response is incomplete.

Show child attributes

enum<string>

The reason why the response is incomplete.Available options: max_output_tokens, content_filter

string | null

The model used to generate the response.

integer

required

The sequence number of this event.

`event: response.output_item.added` chunk object

string

required

The type of the event. Always response.output_item.added.

integer

required

The index of the output item that was added.

object

required

The output item that was added.

Show message

An output message from the model.

string

required

The unique ID of the output message.

object[]

required

The content of the output message.

Show child attributes

enum<string>

required

The type of the output text. Always output_text.Available options: output_text

string

required

The text output from the model.

enum<string>

required

The role of the output message. Always assistant.Available options: assistant

enum<string>

required

The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.Available options: in_progress, completed, incomplete

enum<string>

required

The type of the output message. Always message.Available options: message

Show reasoning

A description of the chain of thought used by a reasoning model while generating a response. Be sure to include these items in your input to the Responses API for subsequent turns of a conversation if you are manually managing context.

string

required

The unique identifier of the reasoning content.

object[]

Reasoning text content.

Show child attributes

enum<string>

required

The type of the reasoning text. Always reasoning_text.Available options: reasoning_text

string

required

The reasoning text from the model.

enum<string>

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.Available options: in_progress, completed, incomplete

enum<string>

required

The type of the object. Always reasoning.Available options: reasoning

Show function_call

A tool call to run a function.

string

required

A JSON string of the arguments to pass to the function.

string

required

The unique ID of the function tool call generated by the model.

string

required

The name of the function to run.

enum<string>

required

The type of the function tool call. Always function_call.Available options: function_call

string

The unique ID of the function tool call.

enum<string>

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.Available options: in_progress, completed, incomplete

integer

required

The sequence number of this event.

`event: response.output_item.done` chunk object

string

required

The type of the event. Always response.output_item.done.

integer

required

The index of the output item that was marked done.

object

required

The output item that was marked done.

Show message

An output message from the model.

string

required

The unique ID of the output message.

object[]

required

The content of the output message.

Show child attributes

enum<string>

required

The type of the output text. Always output_text.Available options: output_text

string

required

The text output from the model.

enum<string>

required

The role of the output message. Always assistant.Available options: assistant

enum<string>

required

The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.Available options: in_progress, completed, incomplete

enum<string>

required

The type of the output message. Always message.Available options: message

Show reasoning

string

required

The unique identifier of the reasoning content.

object[]

Reasoning text content.

Show child attributes

enum<string>

required

The type of the reasoning text. Always reasoning_text.Available options: reasoning_text

string

required

The reasoning text from the model.

enum<string>

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.Available options: in_progress, completed, incomplete

enum<string>

required

The type of the object. Always reasoning.Available options: reasoning

Show function_call

A tool call to run a function.

string

required

A JSON string of the arguments to pass to the function.

string

required

The unique ID of the function tool call generated by the model.

string

required

The name of the function to run.

enum<string>

required

The type of the function tool call. Always function_call.Available options: function_call

string

The unique ID of the function tool call.

enum<string>

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.Available options: in_progress, completed, incomplete

integer

required

The sequence number of this event.

`event: response.content_part.added` chunk object

string

required

The type of the event. Always response.content_part.added.

string

required

The ID of the output item that the content part was added to.

integer

required

The index of the output item that the content part was added to.

integer

required

The index of the content part that was added.

object

required

The content part that was added.

Show output_text

A text output from the model.

enum<string>

required

The type of the output text. Always output_text.Available options: output_text

string

required

The text output from the model.

Show reasoning_text

Reasoning text from the model.

enum<string>

required

The type of the reasoning text. Always reasoning_text.Available options: reasoning_text

string

required

The reasoning text from the model.

integer

required

The sequence number of this event.

`event: response.content_part.done` chunk object

string

required

The type of the event. Always response.content_part.done.

string

required

The ID of the output item that the content part was added to.

integer

required

The index of the output item that the content part was added to.

integer

required

The index of the content part that is done.

object

required

The content part that is done.

Show output_text

A text output from the model.

enum<string>

required

The type of the output text. Always output_text.Available options: output_text

string

required

The text output from the model.

Show reasoning_text

Reasoning text from the model.

enum<string>

required

The type of the reasoning text. Always reasoning_text.Available options: reasoning_text

string

required

The reasoning text from the model.

integer

required

The sequence number of this event.

`event: response.output_text.delta` chunk object

string

required

The type of the event. Always response.output_text.delta.

string

required

The ID of the output item that the text delta was added to.

integer

required

The index of the output item that the text delta was added to.

integer

required

The index of the content part that the text delta was added to.

string

required

The text delta that was added.

integer

required

The sequence number for this event.

`event: response.output_text.done` chunk object

string

required

The type of the event. Always response.output_text.done.

string

required

The ID of the output item that the text content is finalized.

integer

required

The index of the output item that the text content is finalized.

integer

required

The index of the content part that the text content is finalized.

string

required

The text content that is finalized.

integer

required

The sequence number for this event.

`event: response.function_call_arguments.delta` chunk object

string

required

The type of the event. Always response.function_call_arguments.delta.

string

required

The ID of the output item that the function-call arguments delta is added to.

integer

required

The index of the output item that the function-call arguments delta is added to.

string

required

The function-call arguments delta that is added.

integer

required

The sequence number of this event.

`event: response.function_call_arguments.done` chunk object

string

required

The type of the event. Always response.function_call_arguments.done.

string

required

The ID of the item.

integer

required

The index of the output item.

string

required

The function-call arguments.

string

required

The name of the function that was called.

integer

required

The sequence number of this event.

`event: response.reasoning_text.delta` chunk object

string

required

The type of the event. Always response.reasoning_text.delta.

string

required

The ID of the item this reasoning text delta is associated with.

integer

required

The index of the output item this reasoning text delta is associated with.

integer

required

The index of the reasoning content part this delta is associated with.

string

required

The text delta that was added to the reasoning content.

integer

required

The sequence number of this event.

`event: response.reasoning_text.done` chunk object

string

required

The type of the event. Always response.reasoning_text.done.

string

required

The ID of the item this reasoning text is associated with.

integer

required

The index of the output item this reasoning text is associated with.

integer

required

The index of the reasoning content part.

string

required

The full text of the completed reasoning content.

integer

required

The sequence number of this event.

Last modified on July 10, 2026

Container Chat Completions Chunk Object

Container Messages Chunk Object

⌘I

API Reference

Model APIs

Dedicated

Container

Administration

Dataset and File

Friendli SDK

Container Responses Chunk Object

Events

`event: response.created` chunk object

`event: response.in_progress` chunk object

`event: response.completed` chunk object

`event: response.failed` chunk object

`event: response.incomplete` chunk object

`event: response.output_item.added` chunk object

`event: response.output_item.done` chunk object

`event: response.content_part.added` chunk object

`event: response.content_part.done` chunk object

`event: response.output_text.delta` chunk object

`event: response.output_text.done` chunk object

`event: response.function_call_arguments.delta` chunk object

`event: response.function_call_arguments.done` chunk object

`event: response.reasoning_text.delta` chunk object

`event: response.reasoning_text.done` chunk object

​Events

​event: response.created chunk object

​event: response.in_progress chunk object

​event: response.completed chunk object

​event: response.failed chunk object

​event: response.incomplete chunk object

​event: response.output_item.added chunk object

​event: response.output_item.done chunk object

​event: response.content_part.added chunk object

​event: response.content_part.done chunk object

​event: response.output_text.delta chunk object

​event: response.output_text.done chunk object

​event: response.function_call_arguments.delta chunk object

​event: response.function_call_arguments.done chunk object

​event: response.reasoning_text.delta chunk object

​event: response.reasoning_text.done chunk object

Events

`event: response.created` chunk object

`event: response.in_progress` chunk object

`event: response.completed` chunk object

`event: response.failed` chunk object

`event: response.incomplete` chunk object

`event: response.output_item.added` chunk object

`event: response.output_item.done` chunk object

`event: response.content_part.added` chunk object

`event: response.content_part.done` chunk object

`event: response.output_text.delta` chunk object

`event: response.output_text.done` chunk object

`event: response.function_call_arguments.delta` chunk object

`event: response.function_call_arguments.done` chunk object

`event: response.reasoning_text.delta` chunk object

`event: response.reasoning_text.done` chunk object