> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kleep.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Send event

> Report what happened after a recommendation so the retailer sees the chat's impact in the Kleep dashboard: shown, added to cart, ordered.



## OpenAPI

````yaml /partners/openapi.json post /events
openapi: 3.0.3
info:
  title: Kleep Partner API
  version: 1.0.0
  description: >-
    Size recommendations for conversational agents: customer-service agents, AI
    shopping assistants and AI agents, on behalf of Kleep retailers.
servers:
  - url: https://fit.kleep.ai/v1
    description: Production
security:
  - bearerAuth: []
paths:
  /events:
    post:
      summary: Send event
      description: >-
        Report what happened after a recommendation so the retailer sees the
        chat's impact in the Kleep dashboard: shown, added to cart, ordered.
      operationId: createEvent
      parameters:
        - name: Kleep-Retailer
          in: header
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            The retailer's Kleep `public_id`. Every call is scoped to one
            retailer.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Event'
            example:
              type: added_to_cart
              recommendation_id: rec_7Hq2mV9xKp
              variant_id: JEAN-0142-M
              conversation_id: conv_5521
      responses:
        '202':
          description: Accepted.
        '400':
          description: A field is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: invalid_input
                  message: Unknown event type
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: unauthorized
                  message: Invalid API key
        '403':
          description: This retailer has not enabled your integration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: retailer_not_enabled
                  message: Retailer 9b1f… has not enabled this partner
        '429':
          description: >-
            Rate limit reached. Retry after the number of seconds in
            `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: rate_limited
                  message: Too many requests
components:
  schemas:
    Event:
      type: object
      required:
        - type
        - recommendation_id
      properties:
        type:
          type: string
          enum:
            - recommendation_shown
            - added_to_cart
            - order_placed
        recommendation_id:
          type: string
        variant_id:
          type: string
          description: '`added_to_cart` and `order_placed`: the variant bought.'
        order_id:
          type: string
          description: '`order_placed`: the retailer''s order ID.'
        conversation_id:
          type: string
        occurred_at:
          type: string
          format: date-time
          description: Defaults to the time Kleep receives the event.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - retailer_not_enabled
                - invalid_input
                - missing_inputs
                - product_not_found
                - product_not_supported
                - profile_not_found
                - recommendation_not_found
                - rate_limited
                - internal_error
              description: >-
                Stable, machine-readable error code. Branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation, in English. Not meant to be shown to
                shoppers.
            missing:
              type: array
              items:
                type: string
              description: '`missing_inputs` only: the ids of the answers still needed.'
            questions:
              type: array
              items:
                $ref: '#/components/schemas/Question'
              description: >-
                `missing_inputs` only: the questions to ask for the missing
                answers, localized.
            details:
              type: object
              additionalProperties: true
              description: '`invalid_input` only: the offending fields.'
    Question:
      type: object
      required:
        - id
        - required
        - type
        - prompt
      properties:
        id:
          type: string
          description: >-
            Path of the answer in `measurements`, for example `height_cm` or
            `body_shape.hips`.
        required:
          type: boolean
        type:
          type: string
          enum:
            - choice
            - number
            - integer
            - text
        prompt:
          type: string
          description: >-
            Ready-to-ask wording in the requested locale. Rephrase freely to
            match your bot's tone.
        unit:
          type: string
          enum:
            - cm
            - kg
        min:
          type: number
        max:
          type: number
        default:
          type: string
          description: Value Kleep assumes when an optional question is skipped.
        options:
          type: array
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your partner API key: `kp_live_…` in production, `kp_test_…` on the
        sandbox retailer.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.