Python SDKAPI ReferenceComponents

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

FieldTypeRequiredDescriptionExample
annotationcomponents.OpenAIResponsesAnnotation✔️N/A{"file_id": "file-abc123","filename": "research_paper.pdf","index": 0,"type": "file_citation"}
annotation_indexint✔️N/A
content_indexint✔️N/A
item_idstr✔️N/A
output_indexint✔️N/A
sequence_numberint✔️N/A
typecomponents.AnnotationAddedEventType✔️N/A