Hellou AI Agents API

openapi: 3.2.0
info:
  title: HellouOne Agents 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: Agents
paths:
  /api/v1/accounts/{account_id}/agents:
    parameters:
    - $ref: '#/components/parameters/account_id'
    get:
      tags:
      - Agents
      operationId: get-account-agents
      summary: List Agents in Account
      description: Get Details of Agents in an Account. Hellou platform staff are listed only on Hellou internal accounts.
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of all active agents
                items:
                  $ref: '#/components/schemas/agent'
        '403':
          description: Access denied
    post:
      tags:
      - Agents
      operationId: add-new-agent-to-account
      summary: Add a New Agent
      description: Add a new Agent to Account
      security:
      - userApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                description: Newly Created Agent
                $ref: '#/components/schemas/agent'
        '403':
          description: Access denied
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - email
              - role
              properties:
                name:
                  type: string
                  description: Full Name of the agent
                email:
                  type: string
                  description: Email of the Agent
                role:
                  type: string
                  enum:
                  - agent
                  - administrator
                  description: Whether its administrator or agent
                availability_status:
                  type: string
                  enum:
                  - available
                  - busy
                  - offline
                  description: The availability setting of the agent.
                auto_offline:
                  type: boolean
                  description: Whether the availability status of agent is configured to go offline automatically when away.
  /api/v1/accounts/{account_id}/agents/{id}:
    parameters:
    - $ref: '#/components/parameters/account_id'
    patch:
      tags:
      - Agents
      operationId: update-agent-in-account
      summary: Update Agent in Account
      description: Update an Agent in Account
      security:
      - userApiKey: []
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the agent to be updated.
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                description: The updated agent
                $ref: '#/components/schemas/agent'
        '404':
          description: Agent not found
        '403':
          description: Access denied
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - role
              properties:
                role:
                  type: string
                  enum:
                  - agent
                  - administrator
                  description: Whether its administrator or agent
                availability:
                  type: string
                  enum:
                  - available
                  - busy
                  - offline
                  description: The availability setting of the agent.
                auto_offline:
                  type: boolean
                  description: Whether the availability status of agent is configured to go offline automatically when away.
    delete:
      tags:
      - Agents
      operationId: delete-agent-from-account
      summary: Remove an Agent from Account
      description: Remove an Agent from Account. Hellou platform staff cannot be removed (403).
      security:
      - userApiKey: []
      parameters:
      - in: path
        name: id
        required: true
        description: The ID of the agent to be deleted
        schema:
          type: integer
      responses:
        '200':
          description: Success
        '404':
          description: Agent not found
        '403':
          description: Access denied, or the agent is Hellou platform staff
components:
  parameters:
    account_id:
      in: path
      name: account_id
      required: true
      description: The numeric ID of the account
      schema:
        type: integer
  schemas:
    agent:
      type: object
      properties:
        id:
          type: integer
        uid:
          type: string
        name:
          type: string
        available_name:
          type: string
        display_name:
          type: string
        email:
          type: string
        account_id:
          type: integer
        role:
          type: string
          enum:
          - agent
          - administrator
        confirmed:
          type: boolean
        availability_status:
          type: string
          enum:
          - available
          - busy
          - offline
          description: The availability status of the agent computed by HellouOne.
        auto_offline:
          type: boolean
          description: Whether the availability status of agent is configured to go offline automatically when away.
        custom_attributes:
          type: object
          description: Available for users who are created through platform APIs and has custom attributes associated.
  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