Hellou AI Agent Bots API

openapi: 3.2.0
info:
  title: HellouOne Agent Bots 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: AgentBots
paths:
  /platform/api/v1/agent_bots:
    get:
      tags:
      - AgentBots
      operationId: list-all-agent-bots
      summary: List all AgentBots
      description: List all agent bots available
      security:
      - platformAppApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                description: Array of agent bots
                items:
                  $ref: '#/components/schemas/agent_bot'
        '401':
          description: Unauthorized
    post:
      tags:
      - AgentBots
      operationId: create-an-agent-bot
      summary: Create an Agent Bot
      description: Create an agent bot
      security:
      - platformAppApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent_bot'
        '401':
          description: Unauthorized
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/agent_bot_create_update_payload'
  /platform/api/v1/agent_bots/{id}:
    parameters:
    - $ref: '#/components/parameters/agent_bot_id'
    get:
      tags:
      - AgentBots
      operationId: get-details-of-a-single-agent-bot
      summary: Get an agent bot details
      description: Get the details of an agent bot
      security:
      - platformAppApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent_bot'
        '401':
          description: Unauthorized
        '404':
          description: The given agent bot ID does not exist
    patch:
      tags:
      - AgentBots
      operationId: update-an-agent-bot
      summary: Update an agent bot
      description: Update an agent bot's attributes
      security:
      - platformAppApiKey: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent_bot'
        '401':
          description: Unauthorized
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/agent_bot_create_update_payload'
    delete:
      tags:
      - AgentBots
      operationId: delete-an-agent-bot
      summary: Delete an AgentBot
      description: 'Delete an AgentBot. An AI agent with a call in progress cannot be deleted: the

        request answers 422 and nothing changes.'
      security:
      - platformAppApiKey: []
      responses:
        '200':
          description: Success
        '401':
          description: Unauthorized
        '404':
          description: The agent bot does not exist
        '422':
          description: 'The AI agent has a call in progress (`reason: ai_call_in_progress`). Nothing is

            deleted; retry after the call ends.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_message'
components:
  schemas:
    agent_bot:
      type: object
      properties:
        id:
          type: number
          description: ID of the agent bot
        name:
          type: string
          description: The name of the agent bot
        description:
          type: string
          description: The description about the agent bot
        account_id:
          type: number
          description: Account ID if it's an account specific bot
        outgoing_url:
          type: string
          description: The webhook URL for the bot
        bot_type:
          type: string
          enum:
          - webhook
          - csml
          - native
          description: The kind of bot. `native` bots are AI agents configured through their native definition.
    agent_bot_create_update_payload:
      type: object
      properties:
        name:
          type: string
          description: The name of the agent bot
        description:
          type: string
          description: The description about the agent bot
        outgoing_url:
          type: string
          description: The webhook URL for the bot
        bot_type:
          type: string
          enum:
          - webhook
          - csml
          - native
          description: 'The kind of bot. `native` creates an AI agent that runs inside HellouOne

            with every setting at its default (requires the `native_bots` feature);

            configure it through the native definition endpoints. The type of an

            existing bot cannot be changed.

            '
    error_message:
      type: object
      description: An error with a human-readable message.
      properties:
        error:
          type: string
          description: What went wrong.
        reason:
          type: string
          description: Machine-readable cause, when there is one (for example `feature_disabled`).
      required:
      - error
  parameters:
    agent_bot_id:
      in: path
      name: id
      required: true
      description: The ID of the agentbot to be updated
      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