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

# Get Conversation



## OpenAPI

````yaml https://api.vellaro.io/openapi/storefront.json get /api/v1/chat/conversations/{conv_id}
openapi: 3.1.0
info:
  title: Vellaro Storefront API
  description: >-
    The API of storefronts and mobile apps. The store comes from the publishable
    key in the `X-Vellaro-Key` header (or from the store's domain); the
    customer's endpoints also take the customer's token as `Authorization:
    Bearer <access_token>`.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Authentication
    description: >-
      Customer sign-up and login, tokens, password reset, email verification,
      Google and Apple login, two-factor authentication.
  - name: Catalog
    description: Products, categories and brands, with filters, sorting and pagination.
  - name: Search
    description: Full-text product search and suggestions as you type.
  - name: Cart
    description: >-
      The cart of a guest (`X-Cart-Token`) or of the logged-in customer, and the
      extra warranty offered on a product page.
  - name: Checkout & orders
    description: >-
      Checkout, the customer's orders and reorder, «Order on WhatsApp» (cart
      codes, clicks).
  - name: Payments
    description: >-
      The store's payment methods, paying an order again, and the confirmation
      steps of PayPal, PokPay and Iute.
  - name: Account
    description: >-
      The logged-in customer: profile, addresses, wishlist, digital downloads,
      subscriptions, affiliate account.
  - name: Reviews & questions
    description: Product reviews and product questions.
  - name: AI chat
    description: 'The store''s AI shopping assistant: conversations, messages, feedback.'
  - name: Content
    description: CMS pages, menus, banners, flipbooks and information pages.
  - name: Marketing & contact
    description: >-
      Newsletter sign-up and email links, the contact form, campaign click
      tracking.
  - name: Store
    description: >-
      The store for the storefront: brand, public settings, languages,
      translations, currencies, physical stores, theme.
  - name: Devices
    description: Push-notification devices of the mobile app.
paths:
  /api/v1/chat/conversations/{conv_id}:
    get:
      tags:
        - AI chat
      summary: Get Conversation
      operationId: get_conversation_api_v1_chat_conversations__conv_id__get
      parameters:
        - name: conv_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Conv Id
        - name: locale
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 8
                minLength: 2
              - type: 'null'
            description: 'Locale of the page: welcome and starters come in it'
            title: Locale
          description: 'Locale of the page: welcome and starters come in it'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_ConversationHistoryOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ApiResponse_ConversationHistoryOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/ConversationHistoryOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[ConversationHistoryOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ConversationHistoryOut:
      properties:
        conversation:
          $ref: '#/components/schemas/ConversationOut'
        messages:
          items:
            $ref: '#/components/schemas/MessageOut'
          type: array
          title: Messages
      type: object
      required:
        - conversation
        - messages
      title: ConversationHistoryOut
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ConversationOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        tenant_id:
          type: string
          format: uuid
          title: Tenant Id
        locale:
          type: string
          title: Locale
        last_locale:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Locale
        session_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id
        welcome_message:
          type: string
          title: Welcome Message
        starter_prompts:
          items:
            type: string
          type: array
          title: Starter Prompts
        chat_enabled:
          type: boolean
          title: Chat Enabled
        store:
          $ref: '#/components/schemas/StoreIdentityOut'
      type: object
      required:
        - id
        - tenant_id
        - locale
        - session_id
        - welcome_message
        - starter_prompts
        - chat_enabled
        - store
      title: ConversationOut
    MessageOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        role:
          type: string
          title: Role
        content:
          type: string
          title: Content
        tool_calls:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Tool Calls
        created_at:
          type: string
          title: Created At
        products:
          items:
            $ref: >-
              #/components/schemas/app__modules__chat__storefront_router__ProductCardOut
          type: array
          title: Products
          default: []
      type: object
      required:
        - id
        - role
        - content
        - created_at
      title: MessageOut
    StoreIdentityOut:
      properties:
        name:
          type: string
          title: Name
        logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logo Url
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
      type: object
      required:
        - name
      title: StoreIdentityOut
      description: 'The store''s public identity: widget header and contact fallback.'
    app__modules__chat__storefront_router__ProductCardOut:
      properties:
        product_id:
          type: string
          title: Product Id
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
        name:
          type: string
          title: Name
        brand:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
        short_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Short Description
        image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Image Url
        price_min:
          anyOf:
            - type: number
            - type: 'null'
          title: Price Min
        price_max:
          anyOf:
            - type: number
            - type: 'null'
          title: Price Max
        compare_price:
          anyOf:
            - type: number
            - type: 'null'
          title: Compare Price
        in_stock:
          type: boolean
          title: In Stock
          default: false
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        variant_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Variant Id
        variant_count:
          type: integer
          title: Variant Count
          default: 0
        proposal:
          anyOf:
            - $ref: '#/components/schemas/CardProposalOut'
            - type: 'null'
      type: object
      required:
        - product_id
        - name
      title: ProductCardOut
      description: >-
        A product card (`tools/cards.py`): names in the turn's language,

        prices = what the cart charges, `compare_price` only for a real
        discount.


        `variant_id`: what the «Add» button adds, only when the product has one

        active variant (`variant_count`) and it can be bought; `proposal`: on
        the

        card `add_to_cart` prepared. Cards saved before CHAT-10 have none of the

        three: null / 0.
    CardProposalOut:
      properties:
        variant_id:
          type: string
          title: Variant Id
        qty:
          type: integer
          title: Qty
          default: 1
        options:
          additionalProperties:
            type: string
          type: object
          title: Options
          default: {}
      type: object
      required:
        - variant_id
      title: CardProposalOut
      description: 'What `add_to_cart` prepared: the shopper adds it with the card''s button.'
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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