Hellou AI Conversations API

The Conversations API API from Hellou AI — 5 operation(s) for conversations api.

Documentation GitHub OpenAPI

Operations 6

POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations Create a conversation #

GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations List all conversations #

GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id} Get a single conversation #

POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status Resolve a conversation #

POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing Toggle typing status #

POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen Update last seen #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/hellou-ai/openapi/hellou-ai-conversations-api-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-ai-call-report-schema.json

📊

JSONSchema

https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-schema.json

📊

JSONSchema

https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-report-stats-schema.json

📊

JSONSchema

https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-inbox-schema.json

📊

JSONSchema

https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-voice-campaign-create-request-schema.json

📊

JSONSchema

https://artifacts.apis.io/hellou-ai/json-schema/hellou-ai-call-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hellou-ai:hellou-ai-conversations-api-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: HellouOne Conversations API
  version: 1.0.0
  description: 'The HellouOne REST API: everything the dashboard does, available to your

    own systems — CRMs, bots, BI tools and back-office automation.'
  termsOfService: https://hellou.ai/en/legal/terms/
  contact:
    name: HellouOne support
    email: support@hellou.ai
servers:
- url: https://one.hellou.ai
  description: HellouOne cloud
security:
- userApiKey: []
tags:
- name: Conversations API
paths:
  /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations:
    parameters:
    - $ref: '#/components/parameters/public_inbox_identifier'
    - $ref: '#/components/parameters/public_contact_identifier'
    post:
      tags:
      - Conversations API
      operationId: create-a-conversation
      summary: Create a conversation
      security: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/public_conversation'
        '401':
          description: Unauthorized
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/public_conversation_create_payload'
    get:
      tags:
      - Conversations API
      operationId: list-all-contact-conversations
      summary: List all conversations
      description: List all conversations for the contact
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of conversations
                items:
                  $ref: '#/components/schemas/public_conversation'
        '401':
          description: Unauthorized
  /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}:
    parameters:
    - $ref: '#/components/parameters/public_inbox_identifier'
    - $ref: '#/components/parameters/public_contact_identifier'
    - $ref: '#/components/parameters/conversation_id'
    get:
      tags:
      - Conversations API
      operationId: get-single-conversation
      summary: Get a single conversation
      description: Retrieves the details of a specific conversation
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/public_conversation'
        '401':
          description: Unauthorized
        '404':
          description: Conversation not found
  /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_status:
    parameters:
    - $ref: '#/components/parameters/public_inbox_identifier'
    - $ref: '#/components/parameters/public_contact_identifier'
    - $ref: '#/components/parameters/conversation_id'
    post:
      tags:
      - Conversations API
      operationId: resolve-conversation
      summary: Resolve a conversation
      description: Marks a conversation as resolved
      responses:
        '200':
          description: Conversation resolved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/public_conversation'
        '401':
          description: Unauthorized
        '404':
          description: Conversation not found
  /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing:
    parameters:
    - $ref: '#/components/parameters/public_inbox_identifier'
    - $ref: '#/components/parameters/public_contact_identifier'
    - $ref: '#/components/parameters/conversation_id'
    post:
      tags:
      - Conversations API
      operationId: toggle-typing-status
      summary: Toggle typing status
      description: Toggles the typing status in a conversation
      parameters:
      - name: typing_status
        in: query
        required: true
        description: Typing status, either 'on' or 'off'
        schema:
          type: string
      responses:
        '200':
          description: Typing status toggled successfully
        '401':
          description: Unauthorized
        '404':
          description: Conversation not found
  /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seen:
    parameters:
    - $ref: '#/components/parameters/public_inbox_identifier'
    - $ref: '#/components/parameters/public_contact_identifier'
    - $ref: '#/components/parameters/conversation_id'
    post:
      tags:
      - Conversations API
      operationId: update-last-seen
      summary: Update last seen
      description: Updates the last seen time of the contact in a conversation
      responses:
        '200':
          description: Last seen updated successfully
        '401':
          description: Unauthorized
        '404':
          description: Conversation not found
components:
  schemas:
    public_conversation_create_payload:
      type: object
      properties:
        custom_attributes:
          type: object
          description: Custom attributes of the conversation
    public_conversation:
      type: object
      properties:
        id:
          type: integer
          description: Id of the conversation
        inbox_id:
          type: string
          description: The inbox id of the conversation
        messages:
          type: array
          items:
            $ref: '#/components/schemas/message'
          description: Messages in the conversation
        contact:
          type: object
          description: The contact information associated to the conversation
    message:
      type: object
      properties:
        content:
          type: string
          description: The text content of the message
        content_type:
          type: string
          enum:
          - text
          - input_select
          - cards
          - form
          description: The type of the template message
        content_attributes:
          type: object
          description: The content attributes for each content_type
        message_type:
          type: string
          enum:
          - incoming
          - outgoing
          - activity
          - template
          description: The type of the message
        created_at:
          type: integer
          description: The time at which message was created
        private:
          type: boolean
          description: The flags which shows whether the message is private or not
        attachment:
          type: object
          description: The file object attached to the image
        sender:
          type: object
          description: User/Agent/AgentBot object
        conversation_id:
          type: number
          description: ID of the conversation
  parameters:
    public_contact_identifier:
      in: path
      name: contact_identifier
      required: true
      description: The source id of contact obtained on contact create
      schema:
        type: string
    public_inbox_identifier:
      in: path
      name: inbox_identifier
      required: true
      description: The identifier obtained from API inbox channel
      schema:
        type: string
    conversation_id:
      in: path
      name: conversation_id
      required: true
      description: The numeric ID of the conversation
      schema:
        type: integer
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A user''s access token, from **Profile settings → Access token** in the dashboard.

        Requests act with that user''s role: administrators reach everything in their

        account, agents only what their role and visibility settings allow.

        '
    agentBotApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'An agent bot''s access token, shown to administrators on the bot''s settings page.

        Bot tokens reach a limited set of conversation and message endpoints.

        '
    platformAppApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: 'A platform app token, issued by the installation operator. Used to provision

        accounts, users, account memberships and agent bots.

        '
    connectorInvokeToken:
      type: http
      scheme: bearer
      description: 'A connector''s invoke token (`hci_…`), sent as `Authorization: Bearer <token>`.

        Each connector install has its own; it is rotated whenever the connector is

        reconnected or disconnected, so a stale copy stops working.

        '
x-tagGroups:
- name: Guides
  tags:
  - Introduction
  - Authentication
  - Errors
  - Pagination
  - Rate limits
  - Webhook events
- name: Webhook payloads
  tags:
  - Event payloads
- name: Platform
  tags:
  - Accounts
  - Account Users
  - AgentBots
  - Users
- name: Application
  tags:
  - Account AgentBots
  - Agents
  - Automation Rule
  - Campaigns
  - Canned Responses
  - Contacts
  - Contact Labels
  - Conversation Assignment
  - Conversation Labels
  - Conversations
  - Custom Attributes
  - Custom Filters
  - Help Center
  - Inboxes
  - Integrations
  - Macros
  - Messages
  - Profile
  - Reports
  - Security Settings
  - Teams
  - Webhooks
- name: Business tools
  tags:
  - AI Classifications
  - Assignment Settings
  - Calls
  - AI Phone Lines
  - Connectors
  - ElevenLabs Integration
  - Facebook Marketing
  - HellouAI Integration
  - Knowledge Base
  - Marketing Consent
  - Plan Upgrades
  - Voice Campaigns
  - WhatsApp Campaigns
  - WhatsApp Flows
  - WhatsApp Templates
- name: Client
  tags:
  - Inbox API
  - Contacts API
  - Conversations API
  - Messages API
- name: Others
  tags:
  - CSAT Survey Page