---
title: "AnnotationAddedEvent"
---

Event emitted when a text annotation is added to output


## Fields

| Field                                                                                               | Type                                                                                                | Required                                                                                            | Description                                                                                         | Example                                                                                             |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `annotation`                                                                                        | [components.OpenAIResponsesAnnotation](../components/openairesponsesannotation.mdx)                  | :heavy_check_mark:                                                                                  | N/A                                                                                                 | \{<br/>"file_id": "file-abc123",<br/>"filename": "research_paper.pdf",<br/>"index": 0,<br/>"type": "file_citation"<br/>} |
| `annotation_index`                                                                                  | *int*                                                                                               | :heavy_check_mark:                                                                                  | N/A                                                                                                 |                                                                                                     |
| `content_index`                                                                                     | *int*                                                                                               | :heavy_check_mark:                                                                                  | N/A                                                                                                 |                                                                                                     |
| `item_id`                                                                                           | *str*                                                                                               | :heavy_check_mark:                                                                                  | N/A                                                                                                 |                                                                                                     |
| `output_index`                                                                                      | *int*                                                                                               | :heavy_check_mark:                                                                                  | N/A                                                                                                 |                                                                                                     |
| `sequence_number`                                                                                   | *int*                                                                                               | :heavy_check_mark:                                                                                  | N/A                                                                                                 |                                                                                                     |
| `type`                                                                                              | [components.AnnotationAddedEventType](../components/annotationaddedeventtype.mdx)                    | :heavy_check_mark:                                                                                  | N/A                                                                                                 |                                                                                                     |