> ## 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.

# List questions

> The questions to ask a shopper for a category, localized and in the recommended order. Use it to script your bot, or rely on `missing_inputs` from Create recommendation instead.



## OpenAPI

````yaml /partners/openapi.json get /questions
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:
  /questions:
    get:
      summary: List questions
      description: >-
        The questions to ask a shopper for a category, localized and in the
        recommended order. Use it to script your bot, or rely on
        `missing_inputs` from Create recommendation instead.
      operationId: listQuestions
      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.
        - name: category
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/Category'
        - name: gender
          in: query
          schema:
            type: string
            enum:
              - female
              - male
          description: Omit to get the gender question plus both variants.
        - name: locale
          in: query
          schema:
            type: string
            default: en
          description: BCP 47 language tag for prompts and sentences, for example `fr-FR`.
      responses:
        '200':
          description: Questions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  questions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Question'
              example:
                questions:
                  - id: gender
                    required: true
                    type: choice
                    prompt: Do you shop women's or men's sizes?
                    options:
                      - value: female
                        label: Women's
                      - value: male
                        label: Men's
                  - id: height_cm
                    required: true
                    type: number
                    unit: cm
                    min: 120
                    max: 230
                    prompt: How tall are you?
                  - id: weight_kg
                    required: true
                    type: number
                    unit: kg
                    min: 20
                    max: 250
                    prompt: How much do you weigh?
                  - id: age
                    required: true
                    type: integer
                    min: 12
                    max: 100
                    prompt: How old are you?
                  - id: body_shape.stomach
                    required: false
                    type: choice
                    default: medium
                    prompt: How would you describe your stomach?
                    options:
                      - value: flat
                        label: Flat
                      - value: medium
                        label: Medium
                      - value: round
                        label: Round
                  - id: body_shape.hips
                    required: false
                    type: choice
                    default: medium
                    prompt: And your hips?
                    options:
                      - value: narrow
                        label: Narrow
                      - value: medium
                        label: Medium
                      - value: wide
                        label: Wide
        '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:
    Category:
      type: string
      enum:
        - clothing
        - lingerie
        - footwear
        - kids
      description: Sizing category of the product. It decides which questions apply.
    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
    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.'
  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.