> ## Documentation Index > Fetch the complete documentation index at: https://docs.avidoai.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a new annotation > Creates a new annotation. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/avido/openapi.documented.yml post /v0/annotations openapi: 3.1.1 info: title: Avido API description: >- Avido's API for LLM usage events, tool calls, trace management, webhook validation, and more. See each endpoint's request/response schema for details. version: 0.1.0 contact: name: Avido Support email: support@avidoai.com url: https://avidoai.com/support servers: - url: https://api.avidoai.com description: Production API security: - ApiKey: [] ApplicationId: [] paths: /v0/annotations: post: tags: - Annotations summary: Create a new annotation description: Creates a new annotation. operationId: createAnnotation requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAnnotationRequest' responses: '201': description: Successfully created annotation content: application/json: schema: $ref: '#/components/schemas/AnnotationResponse' '400': description: bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: invalid input content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '500': description: internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: CreateAnnotationRequest: type: object properties: title: type: string description: Title of the annotation example: Updated system prompt description: description: A description of what was changed in the application configuration example: The system prompt was updated to include more examples nullable: true type: string createdAt: description: Custom creation date for the annotation (ISO8601 format) example: '2024-08-04T09:19:00Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ traceStepId: description: Optional trace step ID to attach the annotation to a specific step example: 456e7890-e89b-12d3-a456-426614174000 type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ required: - title additionalProperties: false title: CreateAnnotationRequest description: Request body for creating a new annotation AnnotationResponse: type: object properties: data: $ref: '#/components/schemas/AnnotationOutput' required: - data additionalProperties: false title: AnnotationResponse description: Successful response containing the annotation data ErrorResponse: type: object properties: message: type: string description: A human-readable error message explaining the error. example: Resource not found required: - message additionalProperties: false title: ErrorResponse description: Standard error format for failed API operations. ValidationErrorResponse: type: object properties: message: type: string description: A human-readable error message indicating what went wrong. example: Invalid request data issues: type: array items: type: object properties: code: type: string message: type: string path: type: array items: type: string required: - code - message - path additionalProperties: false description: Array of detailed validation error objects. example: - code: invalid_string message: Invalid UUID path: - id required: - message - issues additionalProperties: false title: ValidationErrorResponse description: Details about validation errors in incoming requests. AnnotationOutput: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Unique identifier of the annotation example: 789e4567-e89b-12d3-a456-426614174000 orgId: type: string description: Organization ID that owns this annotation example: org_123456 title: type: string description: Title of the annotation example: Retrieval topK description: anyOf: - type: string - type: 'null' description: What changed in the AI application example: Change the topK on retrieval createdAt: description: When the annotation was created example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ modifiedAt: description: When the annotation was last modified example: '2024-01-05T12:34:56.789Z' type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ traceStepId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' description: Optional trace step ID this annotation is attached to example: 456e7890-e89b-12d3-a456-426614174000 required: - id - orgId - title - createdAt - modifiedAt additionalProperties: false title: Annotation description: >- A single annotation indicating a change in the AI application configuration securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: Your unique Avido API key ApplicationId: type: apiKey in: header name: x-application-id description: Your unique Avido Application ID ````