Search authorized Hover knowledge

POST https://app.hover.team/api/v1/hover/search

Search native human posts and generated updates in launched Spaces where the caller has a confirmed membership. Attached Source records are queried through their permission-filtered remote search seam and returned in a secondary, read-only Sources tier. Authorization is checked again after remote search so an in-flight membership revocation removes every result from that Space.

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://app.hover.team/api/v1/hover/search \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'query="venue handoff"'

Parameters

query string required

Example: "venue handoff"

Search text, normalized to single spaces.


Response

Return values

  • query: string

    The query value. * knowledge: (object)[]

    The knowledge value. * kind: string

    The `kind` value.
    
    • message_id: integer

      The message_id value. * space: object

      The space value. * id: integer

      The `id` value.
      
      • name: string

        The name value. * topic: string

      The topic value. * sender_name: string

      The sender_name value. * timestamp: string

      The timestamp value. * rendered_content: string

      The rendered_content value. * module_name: string

      The module_name value. * output_type: string

      The output_type value. * saved: boolean

      The saved value. * saveable: boolean

      The saveable value. * url: string

      The url value. * sources: (object)[]

    The sources value. * kind: string

    The `kind` value.
    
    • space: object

      The space value. * id: integer

      The `id` value.
      
      • name: string

        The name value. * source: object

      The source value. * record: object

      The record value. * saveable: boolean

      The saveable value. * source_unavailable_count: integer

    The source_unavailable_count value.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "knowledge": [],
    "msg": "",
    "query": "launch",
    "result": "success",
    "source_unavailable_count": 0,
    "sources": []
}