Haptik API

openapi: 3.1.0
info:
  title: Haptik API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 12 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Haptik has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 7
    pages-with-code: 6
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.haptik.ai/bot-as-an-api/how-to-send-file-to-haptik-using-api
  - https://docs.haptik.ai/bot-as-an-api/how-to-send-message-to-haptik-using-api
  - https://docs.haptik.ai/bot-as-an-api/how-to-send-feedback-to-haptik-using-api
  - https://docs.haptik.ai/bot-as-an-api/how-to-createupdate-a-haptik-user-using-api
  - https://docs.haptik.ai/developer-guides/what-are-the-different-apis-that-can-be-used-on-conversation-studio
  - https://docs.haptik.ai/cibil-integration/how-to-generate-p12-certificate-for-cibil
servers:
- url: https://staging-messenger.haptikapi.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.haptik.ai/developer-guides/what-are-the-different-apis-that-can-be-used-on-conversation-studio
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X GET  https://<base-url>/mogambo_api/nodes/faq/create/status/<task_id>/  -H 'authorization: Bearer <TOKEN>'  -H 'client-id:\
          \ <CLIENT ID>'  Possible Statuses: \n Error/Exception : shows the exception/error that occurred for the last step and stops the execution\
          \ \n In Progress : Step Creation is in progress \n Success : Step has been created successfully \nBest Practices \n 1. Assign Chat to\
          \ Agent "
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.haptik.ai/bot-as-an-api/how-to-send-file-to-haptik-using-api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://<BASE_URL>/v1.0/log_file_from_user/  -H 'Authorization: Bearer <TOKEN>'  -H 'client-id: <CLIENT_ID>'  -H\
          \ 'Content-Type: multipart/form-data'  -F \"auth_id=<AUTH_ID>\"  -F \"business_id=<BUSINESS_ID>\"  -F \"message_type=1\"  -F \"file=@/home/user1/Desktop/test.jpg\"\
          \  -F \"message_body=\" \n Base64 images are not supported. \n Was this article helpful? \n \U0001F44D Yes \n \U0001F44E No \n Thanks!\
          \ How could we"
  /GCCS-ws/GlobalCreditPlatformWebServicev2:
    get:
      operationId: get_GCCS_ws_GlobalCreditPlatformWebServicev2
      tags:
      - Gccs Ws
      summary: GET /GCCS-ws/GlobalCreditPlatformWebServicev2
      x-source: https://docs.haptik.ai/cibil-integration/how-to-generate-p12-certificate-for-cibil
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl  command for certificate connectivity   wget -v --certificate=/path/to/certificate.crt --private-key=/path/to/file.key
          --ca-certificate=/path/to/cacertificate.crt https://gccs-in-live.sd.demo.truelink.com/GCCS-ws/GlobalCreditPlatformWebServicev2?wsdl '
  /integration/external/v2.0/get_chat_history/:
    get:
      operationId: get_integration_external_v2_0_get_chat_history
      tags:
      - Integration
      summary: Get Chat Transcripts v2.0
      x-source: https://docs.haptik.ai/developer-guides/what-are-the-different-apis-that-can-be-used-on-conversation-studio
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer <TOKEN>
      - name: Client-ID
        in: header
        required: true
        schema:
          type: string
        description: <CLIENT_ID>
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: application/json
      - name: business_id
        in: query
        required: false
        schema:
          type: string
        description: Business ID for native Haptik consumers
      - name: user_name
        in: query
        required: false
        schema:
          type: string
        description: Haptik user name
      - name: conversation_no
        in: query
        required: true
        schema:
          type: integer
        description: Conversation number of user's chat
      - name: pxut
        in: query
        required: false
        schema:
          type: string
        description: TRACT Packed eXtensible User Token
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Limit on number of messages that the API should return
      - name: response_type
        in: query
        required: false
        schema:
          type: string
        description: Either json (default) or text
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIntegrationExternalV20GetChatHistoryResponse'
      x-evidence:
        kind: documentation
  /integration/external/v2.0/send_chat_to_agent/:
    post:
      operationId: post_integration_external_v2_0_send_chat_to_agent
      tags:
      - Integration
      summary: Move a chat to pending
      x-source: https://docs.haptik.ai/developer-guides/what-are-the-different-apis-that-can-be-used-on-conversation-studio
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer <TOKEN>
      - name: client-id
        in: header
        required: true
        schema:
          type: string
        description: <CLIENT_ID>
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostIntegrationExternalV20SendChatToAgentRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostIntegrationExternalV20SendChatToAgentResponse'
      x-evidence:
        kind: documentation
  /mogambo_api/nodes/faq/create/:
    post:
      operationId: post_mogambo_api_nodes_faq_create
      tags:
      - Mogambo Api
      summary: FAQ Step Creation APIs for KMS
      x-source: https://docs.haptik.ai/developer-guides/what-are-the-different-apis-that-can-be-used-on-conversation-studio
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer <TOKEN>
      - name: client-id
        in: header
        required: true
        schema:
          type: string
        description: <CLIENT_ID>
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: multipart/form-data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostMogamboApiNodesFaqCreateRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostMogamboApiNodesFaqCreateResponse'
      x-evidence:
        kind: documentation
  /mogambo_api/nodes/faq/create/status/{taskId}/:
    get:
      operationId: get_mogambo_api_nodes_faq_create_status_taskId
      tags:
      - Mogambo Api
      summary: Polling API to fetch submitted task Status
      x-source: https://docs.haptik.ai/developer-guides/what-are-the-different-apis-that-can-be-used-on-conversation-studio
      parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer <TOKEN>
      - name: client-id
        in: header
        required: true
        schema:
          type: string
        description: <CLIENT_ID>
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMogamboApiNodesFaqCreateStatusTaskidResponse'
      x-evidence:
        kind: documentation
  /v1.0/log_file_from_user/:
    post:
      operationId: post_v1_0_log_file_from_user
      tags:
      - V1
      summary: File upload API allows you to upload user files via a POST request to the Haptik Platform.
      x-source: https://docs.haptik.ai/bot-as-an-api/how-to-send-file-to-haptik-using-api
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token provided by Haptik
      - name: client-id
        in: header
        required: true
        schema:
          type: string
        description: Client id for your account provided by Haptik
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: multipart/form-data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV10LogFileFromUserRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV10LogFileFromUserResponse'
      x-evidence:
        kind: documentation
  /v1.0/user:
    put:
      operationId: put_v1_0_user
      tags:
      - V1
      summary: PUT /v1.0/user
      x-source: https://docs.haptik.ai/bot-as-an-api/how-to-createupdate-a-haptik-user-using-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV10UserRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PUT  https://staging-messenger.haptikapi.com/v1.0/user/  -H 'Authorization: Bearer <TOKEN>'  -H 'client-id: <CLIENT_ID>'\
          \  -H 'Content-Type: application/json'  -d '{\"auth_id\": \"<AUTH_ID>\", \"name\": \"guest user\", \"language_code\":\"<LANGUAGE_CODE>\"\
          ,\n \"custom_data\": {\n \"<key_1>\": \"<value_1>\",\n \"<key_2>\": \"<value_2>\"\n }}' \n Was this article helpful? \n \U0001F44D Yes\
          \ \n \U0001F44E No \n Thanks! How could we make this"
  /v1.0/user/:
    post:
      operationId: post_v1_0_user
      tags:
      - V1
      summary: Create or Update Haptik User API
      x-source: https://docs.haptik.ai/bot-as-an-api/how-to-createupdate-a-haptik-user-using-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV10UserRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV10UserResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_v1_0_user
      tags:
      - V1
      summary: Create or Update Haptik User API
      x-source: https://docs.haptik.ai/bot-as-an-api/how-to-createupdate-a-haptik-user-using-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV10UserRequest2'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV10UserResponse'
      x-evidence:
        kind: documentation
  /v1.0/{v10id}:
    post:
      operationId: post_v1_0_v10id
      tags:
      - V1
      summary: POST /v1.0/user
      x-source: https://docs.haptik.ai/bot-as-an-api/how-to-createupdate-a-haptik-user-using-api
      parameters:
      - name: v10id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV10V10IdRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST  https://staging-messenger.haptikapi.com/v1.0/user/  -H 'Authorization: Bearer <TOKEN>'  -H 'client-id: <CLIENT_ID>'\
          \  -H 'Content-Type: application/json'  -d '{\"auth_id\": \"<AUTH_ID>\", \"name\": \"guest user\", \"language_code\":\"<LANGUAGE_CODE>\"\
          ,\n \"custom_data\": {\n \"<key_1>\": \"<value_1>\",\n \"<key_2>\": \"<value_2>\"\n }}' \n Update User "
        collapsed_from: 2 example path(s) differing only at v10Id
components:
  schemas:
    GetIntegrationExternalV20GetChatHistoryResponse:
      type: object
      properties:
        chat_json:
          type: array
          description: Array of chat messages when response_type=json
        chat_text:
          type: string
          description: Plain text chat when response_type=text
    PostIntegrationExternalV20SendChatToAgentRequest:
      type: object
      properties:
        team_name:
          type: string
          description: Name of the team to which the chat is to be assigned.
        user_name:
          type: string
          description: Identifier for the User provided by Haptik when invoking the Integration API
        business_id:
          type: number
          description: Numeric identifier for the channel where the User is messaging
        countdown:
          type: number
          description: Time in seconds before chat is moved to queue (5‑10 seconds).
        receiver:
          type: string
          description: Athena is Haptik's internal Smart agent chat.
      required:
      - team_name
      - user_name
      - business_id
      - receiver
    PostIntegrationExternalV20SendChatToAgentResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates if the API was a success or failure
    PostMogamboApiNodesFaqCreateRequest:
      type: object
      properties:
        domain_name:
          type: string
          description: Name of the Domain/Bot
        csv_file:
          type: string
          description: CSV file containing FAQ steps
      required:
      - domain_name
      - csv_file
    PostMogamboApiNodesFaqCreateResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates if the API was a success or failure
        task_id:
          type: string
          description: Job id for the submitted task
    GetMogamboApiNodesFaqCreateStatusTaskidResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates if the API was a success or failure
        status:
          type: string
          description: Status of the task (e.g., In Progress, Success, Error/Exception)
    PostV10LogFileFromUserRequest:
      type: object
      properties:
        auth_id:
          type: string
          description: Alphanumeric User identifier from your system
        business_id:
          type: string
          description: Numeric identifier for channel/queue on which the message is to be registered
        message_type:
          type: string
          description: The message type should be 1 for image and 52 for document
        file:
          type: string
          description: Contents of the file (binary). Max file size allowed is 10MB
        message_body:
          type: string
          description: The message body containing the message to be sent to the bot or agent
      required:
      - auth_id
      - business_id
      - message_type
      - file
    PostV10LogFileFromUserResponse:
      type: object
      properties:
        message_id:
          type: integer
          description: Message id generated by Haptik system
        message_body:
          type: string
          description: Message body that was logged in the Haptik system
        created_at:
          type: string
          description: ISO timestamp denoting when the message was created in the Haptik system
        message_type:
          type: integer
          description: The message type should be 1 for image and 52 for document
        file_url:
          type: string
          description: The URL for the uploaded file
    PutV10UserRequest:
      type: object
      properties:
        auth_id:
          type: string
        name:
          type: string
        language_code:
          type: string
        custom_data:
          type: object
          properties:
            <key_1>:
              type: string
            <key_2>:
              type: string
    PostV10UserRequest:
      type: object
      properties:
        auth_id:
          type: string
          description: This is an alphanumeric User identifier from your System
        mobile_no:
          type: string
          description: Mobile no of the user
        email:
          type: string
          description: Email of the user
        name:
          type: string
          description: Name of the user
        language_code:
          type: string
          description: Language identifier for user's preferred language based on ISO 639-1
        custom_data:
          type: object
          description: Flat JSON object with additional user information
      required:
      - auth_id
    PostV10UserResponse:
      type: object
      properties:
        auth_id:
          type: string
        mobile_no:
          type: string
        email:
          type: string
        name:
          type: string
    PutV10UserRequest2:
      type: object
      properties:
        auth_id:
          type: string
          description: This is an alphanumeric User identifier from your System
        mobile_no:
          type: string
          description: Mobile no of the user
        email:
          type: string
          description: Email of the user
        name:
          type: string
          description: Name of the user
        language_code:
          type: string
          description: Language identifier for user's preferred language based on ISO 639-1
        custom_data:
          type: object
          description: Flat JSON object with additional user information
      required:
      - auth_id
    PutV10UserResponse:
      type: object
      properties:
        auth_id:
          type: string
        mobile_no:
          type: string
        email:
          type: string
        name:
          type: string
    PostV10V10IdRequest:
      type: object
      properties:
        auth_id:
          type: string
        name:
          type: string
        language_code:
          type: string
        custom_data:
          type: object
          properties:
            <key_1>:
              type: string
            <key_2>:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Gccs Ws
- name: Integration
- name: Mogambo Api
- name: V1