> ## Documentation Index > Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt > Use this file to discover all available pages before exploring further. # Create Note > Creates a note on a parent entity. The parent entity type is supplied as the `entityType` (lowercase kebab-case) query parameter; `entityId` and `note` are supplied in the request body. **Required permission:** `company.note:create`. ## OpenAPI ````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/notes openapi: 3.0.3 info: title: AI Insurance External API description: External API for AI Insurance platform version: 1.0.0 contact: email: support@aiinsurance.io servers: - url: https://go.aiinsurance.io description: Production security: - ApiKeyAuth: [] paths: /api/v1/companies/{companyId}/notes: post: tags: - Field Model Notes summary: Create Note description: > Creates a note on a parent entity. The parent entity type is supplied as the `entityType` (lowercase kebab-case) query parameter; `entityId` and `note` are supplied in the request body. **Required permission:** `company.note:create`. operationId: createNote parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/noteEntityType' requestBody: required: true content: application/json: schema: type: object required: - entityId - note properties: entityId: type: string format: uuid description: Parent entity identifier note: type: string description: The note body (must not be empty) displayDate: type: string format: date-time description: >- Optional back-datable "as of" ISO 8601 timestamp. When set, lists display and sort the note by this date instead of `createdAt` — intended for historical imports and integrations. The audit timestamps and creator attribution stay server-set. displayAuthor: type: string maxLength: 255 description: >- Optional user-visible author label (trimmed; must be non-empty). When set, the note is displayed as authored by this label instead of the creator's name — intended for historical imports carrying the source system's author (or a marker like "Data Import"). Audit attribution stays server-set. examples: basic: summary: Create a note value: entityId: 550e8400-e29b-41d4-a716-446655440200 note: Adjuster called the insured for clarification. backdated: summary: Create a backdated historical note value: entityId: 550e8400-e29b-41d4-a716-446655440200 note: Historical claim note imported from the prior system. displayDate: '2011-04-22T14:05:00.000Z' responses: '201': description: Note created successfully content: application/json: schema: type: object properties: id: type: string format: uuid description: The ID of the created note examples: success: summary: Note created value: id: 550e8400-e29b-41d4-a716-446655440020 '400': description: Bad Request - Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: emptyNote: summary: Empty note body value: error: code: InvalidProperties message: 'note: The value is an empty string' userMessages: - The value is an empty string details: - field: note message: The value is an empty string invalidEntityType: summary: Invalid entityType value: error: code: INVALID_ENTITY_TYPE message: Invalid entityType. Must be a configured entity. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' components: parameters: companyId: name: companyId in: path required: true schema: type: string format: uuid description: Company identifier noteEntityType: name: entityType in: query required: true schema: type: string enum: - event - exposure - quote - submission - person - organization - policy description: > Parent entity type (lowercase kebab-case URL slug), e.g. `event`, `exposure`, `policy`. Selects the per-entity permission enforced for the request and scopes the note to its parent entity. PascalCase (`Event`) is rejected with a 400 — matching the `/entities/{type}` path convention. schemas: ErrorResponse: type: object description: Standard error response for all external API endpoints required: - error properties: error: type: object required: - code - message properties: code: type: string description: Machine-readable error code example: VALIDATION_ERROR message: type: string description: Human-readable error message example: 'submissionId: Required field is missing' userMessages: type: array description: >- Clean, verbatim-displayable messages — one entry per failure, free of error-code tags, field paths, and internal noise. Suitable for showing to end users as-is. items: type: string example: - Exposures of type 'company' require an address details: type: array description: Additional details for validation errors (field-level errors) items: type: object properties: field: type: string description: The field that caused the error example: submissionId message: type: string description: Description of the field error example: Required field is missing responses: Unauthorized: description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: error: code: AuthenticationError message: API key authentication required userMessages: - API key authentication required invalidApiKey: summary: >- Invalid API key (e.g. unknown key, or a Bearer token used instead of an API key) value: error: code: AuthenticationError message: Invalid API key userMessages: - Invalid API key Forbidden: description: Forbidden - Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: insufficientPermissions: summary: Insufficient permissions value: error: code: AuthorizationError message: User is not authorized to perform the requested action userMessages: - User is not authorized to perform the requested action companyMismatch: summary: A valid API key naming another company in the URL value: error: code: AuthorizationError message: API key is not scoped to the requested company userMessages: - API key is not scoped to the requested company InternalServerError: description: Internal Server Error - Unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: Unexpected server error value: error: code: UncaughtActionError message: Uncaught error occurred in userMessages: - An unexpected error occurred. Please try again later. securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- API key authentication. Send your raw API key as the `Authorization` header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key` header; those are not accepted. ````