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/hlix-ai:hlix-ai-mentions-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:
  description: Explore the Hlix API for projects, agent teams, and delivery workflows. Authenticate with `x-api-key` and select a Workspace with `X-Organization-Id`. Session-only operations require a signed-in user session. Authentication setup.
  title: reference Mentions API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- name: Mentions
paths:
  /v1/api/mentions:
    get:
      operationId: listUnreadMentions
      parameters:
      - description: Page size, clamped to 1–500; 100 when omitted or not an integer.
        in: query
        name: limit
        required: false
        schema:
          type: string
      - description: Mentions to skip, newest first. `total` counts every unread mention, so it says how many pages there are.
        in: query
        name: offset
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MentionInbox'
          description: One page of the caller's own unread mentions, newest first, and `total`, the count of all of them.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List the caller's unread mentions
      tags:
      - Mentions
  /v1/api/mentions/read:
    post:
      operationId: markMentionsRead
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MentionRead'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MentionReadAck'
          description: The ids that actually changed. An id belonging to another person, or one already read, is absent — naming somebody else's mention does nothing rather than failing.
        '400':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ValidationError'
                - $ref: '#/components/schemas/ApiError'
          description: The JSON body failed schema validation (`ValidationError`), or the request named no active organization (`ApiError`).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: Mark the caller's mentions read
      tags:
      - Mentions
  /v1/api/projects/{projectId}/mention-roster:
    get:
      operationId: getProjectMentionRoster
      parameters:
      - in: path
        name: projectId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/ClientPortal'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MentionRoster'
          description: Workspace members, this project's portal clients and its agents, with the project manager first. Only agency viewers receive email addresses.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such project in this workspace — or the caller is a client collaborator with no grant on it.
      summary: List who this project's conversations can mention
      tags:
      - Mentions
components:
  schemas:
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    MentionReadAck:
      properties:
        read:
          items:
            type: string
          type: array
      required:
      - read
      type: object
    MentionRoster:
      properties:
        agents:
          items:
            properties:
              id:
                type: string
              name:
                type: string
            required:
            - id
            - name
            type: object
          type: array
        users:
          items:
            properties:
              email:
                type: string
              id:
                type: string
              image:
                type:
                - string
                - 'null'
              name:
                type: string
              role:
                type: string
            required:
            - id
            - name
            - image
            - role
            type: object
          type: array
      required:
      - users
      - agents
      type: object
    MentionRead:
      properties:
        ids:
          items:
            minLength: 1
            type: string
          maxItems: 200
          minItems: 1
          type: array
      required:
      - ids
      type: object
    MentionInbox:
      properties:
        items:
          items:
            properties:
              agentId:
                type:
                - string
                - 'null'
              author:
                properties:
                  image:
                    type:
                    - string
                    - 'null'
                  name:
                    type:
                    - string
                    - 'null'
                  userId:
                    type: string
                required:
                - userId
                - name
                - image
                type: object
              createdAt:
                type: string
              cycleId:
                type:
                - string
                - 'null'
              id:
                type: string
              messageId:
                type: string
              projectId:
                type:
                - string
                - 'null'
              projectName:
                type:
                - string
                - 'null'
              snippet:
                type: string
              taskId:
                type:
                - string
                - 'null'
              threadId:
                type: string
            required:
            - id
            - projectId
            - projectName
            - cycleId
            - taskId
            - agentId
            - threadId
            - messageId
            - author
            - snippet
            - createdAt
            type: object
          type: array
        total:
          maximum: 9007199254740991
          minimum: -9007199254740991
          type: integer
        truncated:
          type: boolean
      required:
      - items
      - total
      - truncated
      type: object
    ValidationError:
      properties:
        error:
          properties:
            message:
              type: string
            name:
              type: string
          required:
          - name
          - message
          type: object
        success:
          const: false
          type: boolean
      required:
      - success
      - error
      type: object
  parameters:
    ClientPortal:
      description: The agency Workspace ID for a signed-in client's portal requests. A verified user session and portal membership are required; API keys cannot authenticate portal access. This header does not grant agency administration access.
      in: header
      name: X-Client-Portal
      required: false
      schema:
        type: string
    OrganizationId:
      description: The workspace (organization) to act in. Omitted, the session's active organization is used.
      in: header
      name: X-Organization-Id
      required: false
      schema:
        type: string
      example: YOUR_WORKSPACE_ID
  securitySchemes:
    apiKey:
      description: An API key issued through `/v1/api/auth/api-key/*`. Browser clients can use their session cookie instead.
      in: header
      name: x-api-key
      type: apiKey
    sessionCookie:
      description: The complete session Cookie header issued by sign-in at the selected API host. Cookie names vary by hosting region and environment; preserve the issued name and value. Browsers send these HTTP-only cookies automatically. Session-only operations require this user session and do not accept an API key.
      in: header
      name: Cookie
      type: apiKey