AnnotationAddedEvent - Python SDK

AnnotationAddedEvent method reference

The Python SDK and docs are currently in beta. Report issues on GitHub.

Event emitted when a text annotation is added to output

Fields

Field	Type	Required	Description	Example
annotation	components.OpenAIResponsesAnnotation	:heavy_check_mark:	N/A	{"file_id": "file-abc123","filename": "research_paper.pdf","index": 0,"type": "file_citation"}
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	:heavy_check_mark:	N/A