Skip to main content

Hana API

Please Note

Please note that all IDs are randomized in the responses. So, you might see inconsistencies in the IDs. IDs in actual response will be consistent.

Authorization​

info

Used to authorize API requests to Hana system.

Auth Type​

You need to pass this API key in the header of your requests.

  • API Key
    • Key: X-API-KEY
    • Value: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234

How to Get Your API Key​

  1. Go to the Connectors Page

  2. Find & Connect to the Hana API

    • Look for the "Hana API" connector.
    • Click on "Connect" to generate your API key.

  3. Copy & Save Your API Key

    • The API key will be displayed only once.
    • Make sure to copy and save it securely for future use.
note
  • ⚠️ If you disconnect from the Hana API, your existing API key will become invalid.
  • 🔁 To continue using the API, you must reconnect and generate a new API key using the same steps above.

API Key Validation​

info

Test the connection and validity of the API key.

Request Type​

GET

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/test

cURL Example​

curl -X GET https://hana-api.hanabitech.com/v1/expose-api/test -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234"

Success Response​

{
  "success": true,
  "content": {
    "email": "john-doe@hanabitech.com",
    "role": "ADMIN",
    "displayName": "John Doe",
    "timestamp": "2025-03-09T11:48:40.713Z"
  }
}

Chat Completion​

info

Generate a completion with Hana based on a history of messages. Hana will automatically consider up to date web information and everything in her memory module including auto digested and manually added memories.

Request Type​

POST

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/chat/completion

Payload​

messages: Array of message - required​

  • In the payload, the messages array must contain at least one message. Each message object in the array should have the following properties:

Properties of a message​

  • role: 'user' | 'assistant' - required

    • Specifies the sender's role.
      • user - represents a person interacting with the assistant.
      • assistant - represents a non-human entity such as an AI model or a platform such as Notion etc.

  • content: string - required

    • The content of the message. This is either the query from the user or the response from the assistant.

  • name: string - required

    • A unique identifier for the sender. It could be the user's name (e.g., "alex-jones") or an identifier for the assistant (e.g., "assistant-bot"). Has to be hyphen separated letters only.
{
  "messages": [
    {
      "role": "user",
      "content": "I’m planning to refresh my wardrobe for spring. Any recommendations for must-have items?",
      "name": "alex-jones"
    },
    {
      "role": "user",
      "content": "Same here! I’d love some inspiration for colors and styles that feel trendy this season.",
      "name": "clark"
    },
    {
      "role": "user",
      "content": "Please suggest options that align with Hanabi’s theme and the colors typically associated with spring.",
      "name": "jason-lee"
    }
  ]
}

cURL Example​

curl -X POST https://hana-api.hanabitech.com/v1/expose-api/chat/completion -H "Content-Type: application/json" -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" -d "{\"messages\":[{\"role\":\"user\",\"content\":\"I’m planning to refresh my wardrobe for spring. Any recommendations for must-have items?\",\"name\":\"alex-jones\"},{\"role\":\"user\",\"content\":\"Same here! I’d love some inspiration for colors and styles that feel trendy this season.\",\"name\":\"clark\"},{\"role\":\"user\",\"content\":\"Please suggest options that align with Hanabi’s theme and the colors typically associated with spring.\",\"name\":\"jason-lee\"}]}"

Response​

warning

This endpoint will only generate a request for completion but will not give the actual completion. Actual completion will be given by the completion status endpoint.

{
  "success": true,
  "content": {
    "userId": "65cc6e5c3d23897uuitye1cd",
    "organizationId": "659bdceckkkfh61504844444",
    "messageId": "client-hana-834b16e5-ff7e-4499-8f54-7155e71f955c",
    "completionStartTime": "2025-03-09T12:12:03.388Z",
    "completionFinishTime": null,
    "completionResponse": null,
    "completionStatus": "IN_PROGRESS",
    "_id": "67cd345hgi94679b30ef73b1",
    "createdAt": "2025-03-09T12:12:03.389Z",
    "updatedAt": "2025-03-09T12:12:03.389Z"
  }
}

Chat Completion Status​

info

This endpoint can be used to check the completion status of requested completion. The completionStatus can be IN_PROGRESS, COMPLETED and ERROR. Upon a successful completion, the completionStatus will change to COMPLETED and the completion is available in completionResponse. In all other scenarios, completionResponse will be null.

Statuses Are Temporary

The status of a completion request will be auto-deleted in 3 hours. It will not be available in the response post these 3 hours. Within 3 hours, 100% of the completion requests will resolve to either an ERROR or a COMPLETED state.

Request Type​

GET

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/chat/statuses?messageId={{CHAT_COMPLETION_MESSAGE_ID}}&page={{PAGE_NUMBER}}&per_page={{PAGE_NUMBER_LIMIT}}

Request Params​

  • messageId: string - required

    • Provide the messageId obtained from the Chat Completion response. The expected format is client-hana-123457899.

  • per_page: number - optional

    • The number of records to fetch per page
    • Defaults to 10

  • page: number - optional

    • The page number starting from 1
    • Defaults to 1

cURL Example​

curl -G "https://hana-api.hanabitech.com/v1/expose-api/chat/statuses" -H "Content-Type: application/json" -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" --data-urlencode "page=1" --data-urlencode "per_page=1" --data-urlencode "messageId=client-hana-03b495e3-4ba1-457e-9065-749545b6f33e"

Response​

tip

In your automations, do check for completion status as "COMPLETED" and completionResponse as truthy.

Completion in Progress​

{
  "success": true,
  "content": {
    "data": [
      {
        "_id": "67chyt3e569356hgt46782f6",
        "userId": "65cc6e5c3d888f7a7e33e1cd",
        "organizationId": "659bdce4657hg61504845984",
        "messageId": "client-hana-03b495e3-4ba1-457e-9065-749545b6f33e",
        "completionStartTime": "2025-03-09T17:22:06.638Z",
        "completionFinishTime": null,
        "completionResponse": null,
        "completionStatus": "IN_PROGRESS",
        "createdAt": "2025-03-09T17:22:06.639Z",
        "updatedAt": "2025-03-09T17:22:06.639Z"
      }
    ],
    "totalCount": 1
  }
}

Completion Completed​

{
  "success": true,
  "content": {
    "data": [
      {
        "_id": "67cd345dgt68888g30efb2f6",
        "userId": "65cc6e54675htkio9e33e1cd",
        "organizationId": "659bd67kioi7561504845984",
        "messageId": "client-hana-03b495e3-4ba1-457e-9065-749545b6f33e",
        "completionStartTime": "2025-03-09T17:22:06.638Z",
        "completionFinishTime": "2025-03-09T17:22:36.867Z",
        "completionResponse": "To align your wardrobe with Hanabi’s theme and the colors typically associated with spring, consider the following suggestions:\n\n1. *Hanabi Theme*: Hanabi, meaning \"fireworks\" in Japanese, inspires vibrant and dynamic imagery. Opt for bold, colorful outfits with patterns reminiscent of fireworks, such as bright floral prints or geometric designs.\n\n2. *Spring Colors*: Spring is often associated with pastel shades, bright whites, and soft greens. Incorporate these colors through accessories like scarves, hats, or shoes in pastel hues, or choose clothing items like light green dresses or white tops with floral patterns.\n\n3. *Combining Themes*: For a look that combines both themes, consider a pastel-colored dress with fireworks-inspired accessories, such as a bold, colorful scarf or statement jewelry that reflects the dynamic colors of fireworks. Alternatively, a white or light-colored outfit with vibrant floral patterns can capture the essence of spring while nodding to the celebratory aspect of Hanabi.\n\nThese suggestions blend the vibrant and celebratory nature of Hanabi with the freshness of spring, creating a unique and stylish wardrobe update.",
        "completionStatus": "COMPLETED",
        "createdAt": "2025-03-09T17:22:06.639Z",
        "updatedAt": "2025-03-09T17:22:36.867Z"
      }
    ],
    "totalCount": 1
  }
}

Completion Error​

{
  "success": true,
  "content": {
    "data": [
      {
        "_id": "67cdce3e569053hjuytgyhf6",
        "userId": "65cc6e5c3d88af567ghte1cd",
        "organizationId": "659bdceca578561504845984",
        "messageId": "client-hana-03b495e3-4ba1-457e-9065-749545b6f33e",
        "completionStartTime": "2025-03-09T17:22:06.638Z",
        "completionFinishTime": "2025-03-09T17:22:36.867Z",
        "completionResponse": null,
        "completionStatus": "ERROR",
        "createdAt": "2025-03-09T17:22:06.639Z",
        "updatedAt": "2025-03-09T17:22:06.639Z"
      }
    ],
    "totalCount": 1
  }
}

Report Message Creation​

info

Creates a report group message. It is very powerful with automations. Other platforms or systems can "report" to Hana and then you can QnA over the ingested messages. For example, you can create a report group called notion_tech_updates. You can call the Notion API in your server to check for sprint board status daily and report this to Hana by creating a report message using this endpoint in notion_tech_updates.

Then you can simply ask in Google Chat: /reportGroups Hana, what is the status of the sprint board today in notion_tech_updates? /reportGroups Hana, what has been completed this week in the sprint board in notion_tech_updates?

Request Type​

POST

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/report-groups/report-messages
note
  • A report group should be created before executing report message creation.
  • If not already created, create a report group

Payload​

In the payload, the object must contain all required properties. Each property should be structured as follows:

  • reportGroupName: string - required
    • The name of the report group where this message should be added.
    • Always small letters with hyphens and no spaces.
  • sourcePlatform: string - required
    • The platform where the reported message originated from (e.g., "Website" , "Slack", "Google Chat", "Microsoft Teams").
  • messageTitle: string - required
    • A short summary or title for the report message.
  • messageString: string - required
    • The actual message content that is being reported.
{
  "reportGroupName": "web-development-project",
  "messageString": "The new dashboard UI is much better, but the loading time is still slow when switching between reports.",
  "messageTitle": "UI Improvement Feedback",
  "sourcePlatform": "Slack"
}

cURL Example​

curl -X POST "https://hana-api.hanabitech.com/v1/expose-api/report-groups/report-messages" -H "Content-Type: application/json" -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" -d "{\"reportGroupName\":\"web-development-project\",\"messageString\":\"The new dashboard UI is much better, but the loading time is still slow when switching between reports.\",\"messageTitle\":\"UI Improvement Feedback\",\"sourcePlatform\":\"Slack\"}"

Response​

{
  "success": true,
  "content": {
    "reportGroupName": "web-development-project",
    "messageString": "The new dashboard UI is much better, but the loading time is still slow when switching between reports.",
    "messageTitle": "UI Improvement Feedback",
    "sourcePlatform": "SLACK"
  }
}

Create Google Chat Message​

info

Very poweful with automations allowing Hana to keep your communication spaces updated with relevant and important information. Use this endpoint to allow Hana to create a Google Chat message. Formatting rules of Google Chat Message apply - Formatting Rules.

Request Type​

POST

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/chat/create-google-chat-message
Ensure Hana is Integrated in the Desired Space

Before sending a message using the Hana API, you must first ensure that Hana is integrated into the target chat space. If Hana is not already added to the space, she must be added prior to message creation.

Payload​

In the payload, the object must contain all required properties. Each property should be structured as follows:

  • message: string - required
    • The actual text content of the message being sent.
  • spaceName: string - required
    • The unique identifier of the chat space or conversation where the message should be delivered.
    • Always of the format - spaces/AAAAR9-3Sxs
{
  "message": "📢 **Sales Update:** Great news! We closed 5 major deals this week, bringing in a total revenue of $250,000. 🚀 Kudos to the sales team for their hard work! Let’s keep up the momentum and push for an even stronger quarter. 💪",
  "spaceName": "spaces/AAAA1234xyz"
}

How to Get the spaceName​

From Google Chat URL​

  • Open the desired chat space in your browser.

  • Look at the URL bar, example:

    • https://mail.google.com/chat/#chat/space/AAAA1234xyz
    • The part after /space/ (example: AAAA1234xyz) is the spaceId.
    • Format the spaceName:
      • Prefix thespaceId with spaces/ to create the spaceName.
      • Example: If thespaceId is AAAA1234xyz, then the spaceName will be {"spaceName": "spaces/AAAA1234xyz"}

cURL Example​

curl -X POST "https://hana-api.hanabitech.com/v1/expose-api/chat/create-google-chat-message" -H "Content-Type: application/json" -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" -d "{\"message\":\"📢 **Sales Update:** Great news! We closed 5 major deals this week, bringing in a total revenue of $250,000. 🚀 Kudos to the sales team for their hard work! Let’s keep up the momentum and push for an even stronger quarter. 💪\",\"spaceName\":\"spaces/AAAA1234xyz\"}"

Response​

{
  "success": true,
  "content": "📢 **Sales Update:** Great news! We closed 5 major deals this week, bringing in a total revenue of $250,000. 🚀 Kudos to the sales team for their hard work! Let’s keep up the momentum and push for an even stronger quarter. 💪"
}

Get Report Groups​

info

Get the report groups created in Hana system.

Request Type​

GET

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/report-groups?page={{PAGE_NUMBER}}&per_page={{PAGE_NUMBER_LIMIT}}&search={{SEARCH_QUERY}}

Request Params​

  • search: string - optional

    • Filters the result for a particular search string

  • per_page: number - optional

    • The number of records to fetch per page
    • Defaults to 10

  • page: number - optional

    • The page number starting from 1
    • Defaults to 1

cURL Example​

curl -G "https://hana-api.hanabitech.com/v1/expose-api/report-groups" -H "Content-Type: application/json" -H "X-API-KEY:HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" --data-urlencode "per_page=10" --data-urlencode "page=1" --data-urlencode "search=daily"

Response​

{
  "success": true,
  "content": {
    "data": [
      {
        "_id": "65b25ioioootgh7dbdb0a5e7",
        "title": "daily_standup",
        "createdBy": {
          "_id": "65cc60397654444a7e33e1cd",
          "userID": "users/105181644445434675678",
          "email": "nav.archer@hanabitech.com",
          "displayName": "Nav Aggarwal",
          "role": "ADMIN",
          "isActive": true,
          "organizationId": "659bdciou0c7561345gty984",
          "createdAt": "2024-02-14T07:40:12.108Z",
          "updatedAt": "2025-03-09T17:28:44.306Z",
          "__v": 0,
          "profilePicture": "https://lh3.googleusercontent.com/a-/ALV-UjWw3lBBbVEgrMu2T61t7ySwA5VG6U0i7H1tENmSVA_Y5pGuS0ux6ZhzEFH0YW7SEP8aN0bk-BUc08P4ooaSejAh7jT0Hfbp2r6uCxkRDhlbh0Sbtzckmv3o9cTzEAnt9JKClxKsy54CxBje-UUlsv4oauu2feyIL10NpBJcOOdHze_P7EqL8EpEAdqNbnjB-UC_uip5hSmJvX2T-bi7oP_DBHw7co8A9R_Qmc6LdQ4qADA4ZIEwni_qi5X4tXkOtvp6N_lJNd5XtFJqbhrJw1uvmkU1yk71GaGEssXmb7-86CT-CuaA6sSufx2P5nl8C6cQSfKo4v4khUI5ev54PHe9v9BcWbfknNZxN3Q5M-c5Mnh2Nri4atebKb8XdBnFOeKplP0nS-rVKNURj_JnCDW_gmwK-43VANV1MF6f3trdMGWz6LYfj_JrjFLFT0lPMzy6BbibVj3itEQYs5ed-vQNTMbQ7OqqDcmuFbCy2V6JbiWHSj2dI8Mvxzx0-7kiE6yfKGBBEQem7TZ8GJgfDPBP0NOjcBEHdGDudHYo33yeq268225xkRB5RM7zKRr3x927t77OxgdkMNQpdlB8iPBpFtH67JwwiALpOvgmbVhEXWrwRH1gdaMc9zikUiM-csPSVzvIN-yVdhn0Q2v42My6ngKGfy8YPV2RKquEL7gxFL97xV9DdG1VN3B3TAMKn_Jie0SkUwkmltFzYDmSaveIr3kao8Sp0jm-pKMUitHyQz9db2mOISDCfeNvXJjPuVYwVgwPIdJzW9h2qPfWxeORSJT_p4nbsZG3A-wGfCflbzdvFDcDjBJFh033-sPwZefppeDInJH4Fhz38m3toUbv6O1ZT0IE6pCDE5Vhk1ogtU61f5_X0kTwzglEpb70Lo8q5z2aMElucUOU1RQ4ZsrnaenRq7c8X9EVGkMbojCgSYx1dCK7bYJacmmYFnmFzHUm5BoyHT58Y2cOVbOWwKYTXQ=s512-c",
          "updatedBy": "65bb78f3ciu8566fc9a3c95c",
          "designation": "Chief Executive Officer"
        },
        "organizationId": "659bdctyu787561504845984",
        "createdAt": "2024-01-25T13:10:16.277Z",
        "updatedAt": "2024-07-18T02:40:05.679Z",
        "score": 0.9611515998840332
      }
    ],
    "totalCount": 1,
    "llmDigestableOutput": "REPORT GROUP TITLE: daily_standup\nREPORT GROUP CREATED BY NAME: Nav Aggarwal\nREPORT GROUP CREATED BY EMAIL: nav.archer@hanabitech.com\nREPORT GROUP CREATED BY GOOGLE USER ID: users/105181687528191327628"
  }
}

Get Report Group Messages​

info

Get the report group messages created in a particular report group.

Request Type​

GET

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/report-groups/{{REPORT_GROUP_ID}}/report-messages?page={{PAGE_NUMBER}}&per_page={{PAGE_NUMBER_LIMIT}}&search={{SEARCH_QUERY}}&startTimestamp={{START_TIME_STAMP}}&&endTimestamp={{END_TIME_STAMP}}
  • Here REPORT_GROUP_ID is the _id of the report groups for which the messages must be fetched

Request Params​

  • search: string - optional

    • Filters the result for a particular search string

  • per_page: number - optional

    • The number of records to fetch per page
    • Defaults to 10

  • page: number - optional

    • The page number starting from 1
    • Defaults to 1

  • startTimestamp: string - optional

    • The start timestamp from which the messages must be fetched (inclusive)
    • Example - 2025-02-16T01:42:07.213Z

  • endTimestamp: string - optional

    • The end timestamp till which the messages must be fetched (inclusive)
    • Example - 2025-02-17T01:00:07.213Z

cURL Example​


curl -G "https://hana-api.hanabitech.com/v1/expose-api/report-groups/65b25db82f0f9afdbdb0a5e7/report-messages" -H "Content-Type: application/json" -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" --data-urlencode "per_page=10" --data-urlencode "page=1" --data-urlencode "search=Notion" --data-urlencode "startTimestamp=2024-01-14T07:40:12.108Z" --data-urlencode "endTimestamp=2024-03-14T07:40:12.108Z"

Response​

{
  "success": true,
  "content": {
    "data": [
      {
        "_id": "67c846e75777777b30ead59e",
        "reportGroupId": "65b25djuiy0f9afdbdb0a5e7",
        "description": "I am still working on docs only. It will take some time cause I need to add a lot of things even automation examples. Should be done this week. I also connected with Deep Makadiya to debug database issue in prod which caused memories to not save in persistent volume. This is fixed now. We have made several major strides. Hana has gone fully live on zapier. We have exited the beta mode. Also, I have applied some upwork proposals. Added more tickets on notion. Assigned leaders for high level tracks.",
        "createdBy": {
          "_id": "65cc6e5c3d88af7oiuy22332",
          "userID": "users/105189877528191353456",
          "email": "nav.archer@hanabitech.com",
          "displayName": "Nav Aggarwal",
          "role": "ADMIN",
          "isActive": true,
          "organizationId": "659kioeca0c7561504845984",
          "createdAt": "2024-02-14T07:40:12.108Z",
          "updatedAt": "2025-03-09T18:28:32.988Z",
          "__v": 0,
          "profilePicture": "https://lh3.googleusercontent.com/a-/ALV-UjXoIMmnmgogoGasMykT6NcgcNN9AAm1sQcJ_q4iCT432NsOPwJ12oix2OVe9rW24DOC6d4uB4vft_B5lacp3Nswy1uFOdvZJTiA3rhlU2a880YXLUJe0Owk53UVKSKKzMia9KeKoGijyrTsavYW6fkrAzrpLs34fAWouiSdiVWw7phxmtdOJYRjg9SKvl-Zzoc62VQl0G7J0QsySS9PK0RXathbVP5VqnBgP_1CTghDEHwuvKjmfM_y5YUvjodZFLWImHFiGJOWFyTfz4CHBe9KaLJ5YJ-pW31DT6DP1MBrgiww3Looeoylj44-861ypvGn2Ws9KGkeQl3PcT1FA6-73dPdvLDC5k5UDxpMakXASY_S9XZwrWA0fVjbLVuLi8LK2hYrte0Loy8yRiIEUzNHmCh5aNG91yw1by-IMaq6Y0TblZ2ODhZdw_KGC0TxiNH9Ycs8NFNsM7tDRa3Rf0rrgYnpduVg3HwdM05QImgU31m2stJO3yK8rqEcojDtPmGgwE8bVzf2E4p_QLqlH4ezY-_uWG4Zko_dSi7fRJci4WLgpY5NZHU3GqZ7p0v7uSjZQVuYVIZdzADcJCRcpAwTCHy5KqUTYIaldmKv-ISbiiwz1rik5GYcG_my5hsmconNJdUEcI1NjTzW5wZ3qBNHVR5Y_wUyd8BZFT8eDZsZm7X_Yfb2rhtGED-5n-tPp0anBS88w4adthQYTXdNyn7AV6ked9VFxs501ciDpGKfP6qKFWQgc_YGjSHcmsovvBrs4W2HQmzwifSulX5J2z5llhEfN0i1pHtGff5q8-akket_iGZ3d25J27d13BqBTGbWHeyrWQmZeFjgyG_sR7FtbMBD67LGBi8NOClF5B0U_rI-ijKv0Nn5JOU7QjI-yJoWLOHvTokQeG5VcH2Liag2Uc3JuAmqViE6p7rAu3LaFy6_R_LtMvqc4ymrMfWneY84x5GCQFZ0Q7xUNM5nkso4ANLk=s512-c",
          "updatedBy": "65bb78f3c909876fc9a3c95c",
          "designation": "Chief Executive Officer"
        },
        "organizationId": "659bdcecajgh561504845984",
        "createdAt": "2025-03-05T12:43:19.377Z",
        "updatedAt": "2025-03-05T12:43:19.377Z",
        "score": 1.3040423393249512
      },
      {
        "_id": "67c7084bUI8979b30e9c3e8",
        "reportGroupId": "65b25dJUIf0f9afdbdb0a5e7",
        "description": "implemented working salesforce connector with access token instead of secret token, pem files. Zapier incorrect redirect URL fixed. Made a PR. Working on slash command usage bug. Actually, there is no start/date implemented in API side. Facing some issue with Dates in aggregation pipeline. Tried $Match, $and inside $cond, $gte, $gte with Array. Will fix.",
        "createdBy": {
          "_id": "65bb78f3c573566fJUI3c95c",
          "userID": "users/108765432926865728187",
          "email": "santhosh.kumar@hanabitech.com",
          "displayName": "Santhosh Kumar",
          "role": "USER",
          "isActive": true,
          "organizationId": "659bkio9a0c7561504845984",
          "createdAt": "2024-02-01T10:56:51.966Z",
          "updatedAt": "2025-03-09T18:35:19.535Z",
          "__v": 0,
          "profilePicture": "https://lh3.googleusercontent.com/a-/ALV-UjUVkqzOtNRQGeu2R619kXaSdev2uF3xUbLd3PZz08Tdab6m0X46p0D7ZQUwPsprcCLdEE_e9M3ijQ09ZYV1UCH-OhKR4UAM5o3EhBopUwuSvSeOB2QgWl1cNg3Wv0GQEu85YcTsEs2NIa3spn5RqOeoPK8hTnR3HmiX6whgW5OTKbDp_KOP73uEWkUzo8St_1MBfKW6HH_8Ar9MzHWNTsEWwfZYQAH8mY7HD3PraeUuFoebKmzL1XVKWIgRAmGCqtxxKZlVOSdHtjQOv-5bkShast6dpWvEf5BuPcdz_JjgJixQQfEdD-b3uFoE0VEKxWYViivy-RI59Rc-itBzVv1ngh7pdcbsEcYtRN6bVt0vC4Yjpj7CPRMidCf-C6nuvBsG4ow_8ty2x4QBUZa0ReZi-xDhDliYewfPUkT4rTmnwrPEIDqCTpLvENiNt4hsbYRsbN1hzerMncWfvLirI4J9eo9-1C7xAPDycpFNDFp75DMnRJ-GcPRg-Yv-MO6QMBkl2QG-a-OJaF5ipMENBCT737bEbSpqHKH4_KUSOXTy3himSMZE-FtFDdg2WGZDAKnS1zBQVYaZqnmzoZahJ-c8LN70w9Y3R39W517Qb9wTt7ql_Cu1Cw-dzjOM8YK-YDRJ7Ts-wIQRUvGa_6WjhY4aM68Fs1_6IsFs2VhNhrFGuM_2Il6QQ_-nQ4N5d3et_qH53onx_lcpqaCGfwCbzSQy3ThihO4yQdhyc4NMSFSGDbj-UurZcxfGCeO6V0frucRs9GKbM9G0HuUx4bYXvur4GZgT_Jww83hFhokNXEtoulfp1K3UgcaLXv_rmUEYCo2tlc5u3Tb5FMVfK1xSdy27SBz2l6-L3gcUHkvHcBF_67-0vtJJsyP9c2on66PJA1NUR-sGhhM32zYZZchrFD4wrbUE3gBtgLxKaLptR4ZaA9TjtjKTvmGI_ByNs4mGbY07DwhcNI1yaQCaDA02T3a6=s512-c",
          "updatedBy": "65cc6e5c3d88kioa7e33e1cd",
          "designation": "Full Stack Developer"
        },
        "organizationId": "659bdceca0cKIUY784845984",
        "createdAt": "2025-03-04T14:03:55.977Z",
        "updatedAt": "2025-03-04T14:03:55.977Z",
        "score": 1.6430115699768066
      }
    ],
    "totalCount": 2,
    "llmDigestableOutput": "REPORT GROUP MESSAGE TITLE: NA\nREPORT GROUP MESSAGE DESCRIPTION: I am still working on docs only. It will take some time cause I need to add a lot of things even automation examples. Should be done this week. I also connected with Deep Makadiya to debug database issue in prod which caused memories to not save in persistent volume. This is fixed now. We have made several major strides. Hana has gone fully live on zapier. We have exited the beta mode. Also, I have applied some upwork proposals. Added more tickets on notion. Assigned leaders for high level tracks.\nREPORT GROUP MESSAGE PLATFORM SOURCE: NA\nREPORT GROUP MESSAGE CREATED DATE: Wed Mar 05 2025 12:43:19 GMT+0000 (Coordinated Universal Time)\nREPORT GROUP MESSAGE CREATED BY NAME: Nav Aggarwal\nREPORT GROUP MESSAGE CREATED BY EMAIL: nav.archer@hanabitech.com\nREPORT GROUP MESSAGE CREATED BY GOOGLE USER ID: users/105181687528191327628\n\nREPORT GROUP MESSAGE TITLE: NA\nREPORT GROUP MESSAGE DESCRIPTION: implemented working salesforce connector with access token instead of secret token, pem files. Zapier incorrect redirect URL fixed. Made a PR. Working on slash command usage bug. Actually, there is no start/date implemented in API side. Facing some issue with Dates in aggregation pipeline. Tried $Match, $and inside $cond, $gte, $gte with Array. Will fix."
  }
}

Get Spaces Hana is Integrated In​

info

Get the Google Chat spaces Hana is integrated in.

Request Type​

GET

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/spaces?page={{PAGE_NUMBER}}&per_page={{PAGE_NUMBER_LIMIT}}&search={{SEARCH_QUERY}}

Request Params​

  • search: string - optional

    • Filters the result for a particular search string

  • per_page: number - optional

    • The number of records to fetch per page
    • Defaults to 10

  • page: number - optional

    • The page number starting from 1
    • Defaults to 1

cURL Example​

curl -G "https://hana-api.hanabitech.com/v1/expose-api/spaces" -H "Content-Type: application/json" -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" --data-urlencode "per_page=10" --data-urlencode "page=1" --data-urlencode "search=test"

Response​

{
  "success": true,
  "content": {
    "data": [
      {
        "_id": "6746b605674hg234ab6f02d5",
        "spaceId": "spaces/AGGGG6QArts",
        "orgId": "659bd4788jh7561504845984",
        "displayName": "test",
        "spaceType": "GROUP_CHAT",
        "description": null,
        "spaceCreatedAt": "2024-11-27T06:00:37.312Z",
        "isActive": true,
        "isAutoInitiationEnabled": true,
        "createdAt": "2024-11-27T06:02:45.124Z",
        "updatedAt": "2024-11-27T06:02:45.124Z",
        "score": 1.8675340414047241
      },
      {
        "_id": "6620047ghtyud442816c83d2",
        "spaceId": "spaces/AAAAutyRiiU",
        "orgId": "659bdceca0c7748iut845984",
        "displayName": "test",
        "spaceType": "GROUP_CHAT",
        "description": null,
        "spaceCreatedAt": "2024-04-17T17:17:56.113Z",
        "isActive": true,
        "createdAt": "2024-04-17T17:18:46.442Z",
        "updatedAt": "2024-04-17T17:18:46.442Z",
        "score": 1.8675340414047241
      },
      {
        "_id": "67bb9457f4777713394a344b",
        "spaceId": "spaces/AAHGTQJOWhA",
        "orgId": "659bdceca0iujh8764845984",
        "displayName": "Temp Test",
        "spaceType": "GROUP_CHAT",
        "description": null,
        "spaceCreatedAt": "2025-02-23T21:32:28.036Z",
        "isActive": true,
        "isAutoInitiationEnabled": true,
        "isAutoMemoryIngestionEnabled": false,
        "createdAt": "2025-02-23T21:34:15.266Z",
        "updatedAt": "2025-03-06T10:36:19.023Z",
        "score": 1.5343365669250488
      },
      {
        "_id": "6734df624e17jhytbd7f8c4f",
        "spaceId": "spaces/AAAHHHn9p20",
        "orgId": "659bdceca0KIUYTH04845984",
        "displayName": "[TEMP]: Test Space",
        "spaceType": "GROUP_CHAT",
        "description": null,
        "spaceCreatedAt": "2024-09-08T06:33:26.300Z",
        "isActive": true,
        "isAutoInitiationEnabled": true,
        "createdAt": "2024-11-13T17:18:26.793Z",
        "updatedAt": "2025-02-22T18:43:58.778Z",
        "score": 1.3020334243774414
      },
      {
        "_id": "66a8d4e3784a8KKKKff230f9",
        "spaceId": "spaces/AAIUTRKje9s",
        "orgId": "659bdcecaJIUY&*(04845984",
        "displayName": "[TEST] Hana testing",
        "spaceType": "GROUP_CHAT",
        "description": "Everything about the testing of Hana bot",
        "spaceCreatedAt": "2024-03-26T09:20:30.047Z",
        "isActive": true,
        "createdAt": "2024-07-30T11:56:19.852Z",
        "updatedAt": "2025-01-23T08:22:19.423Z",
        "isAutoInitiationEnabled": true,
        "score": 1.3020334243774414
      },
      {
        "_id": "65cc9dd63d88I9Ua7e33e31a",
        "spaceId": "spaces/UYTRzu2E6Rg",
        "orgId": "659bdcecJU87651504845984",
        "displayName": "Hana Test Group",
        "spaceType": "GROUP_CHAT",
        "description": null,
        "spaceCreatedAt": "2024-01-16T19:46:41.882Z",
        "isActive": true,
        "createdAt": "2024-02-14T11:02:46.045Z",
        "updatedAt": "2024-02-14T11:02:46.045Z",
        "score": 1.3020334243774414
      }
    ],
    "totalCount": 6,
    "llmDigestableOutput": "SPACE NAME: test\nSPACE DESCRIPTION: NA\nSPACE GOOGLE CHAT ID: spaces/AAAAA6QArts\nSPACE GOOGLE CHAT TYPE: GROUP_CHAT\nSPACE CREATED DATE IN GOOGLE CHAT: Wed Nov 27 2024 06:00:37 GMT+0000 (Coordinated Universal Time)\nSPACE ACTIVE STATUS: true\nCAN Hana AUTO INITIATE MESSAGES in SPACE: true\nCAN Hana AUTO DIGEST MEMORIES in SPACE: false\n\nSPACE NAME: test\nSPACE DESCRIPTION: NA\nSPACE GOOGLE CHAT ID: spaces/AAAAUk0RiiU\nSPACE GOOGLE CHAT TYPE: GROUP_CHAT\nSPACE CREATED DATE IN GOOGLE CHAT: Wed Apr 17 2024 17:17:56 GMT+0000 (Coordinated Universal Time)\nSPACE ACTIVE STATUS: true\nCAN Hana AUTO INITIATE MESSAGES in SPACE: false\nCAN Hana AUTO DIGEST MEMORIES in SPACE: false\n\nSPACE NAME: Temp Test\nSPACE DESCRIPTION: NA\nSPACE GOOGLE CHAT ID: spaces/AAAAsQJOWhA\nSPACE GOOGLE CHAT TYPE: GROUP_CHAT\nSPACE CREATED DATE IN GOOGLE CHAT: Sun Feb 23 2025 21:32:28 GMT+0000 (Coordinated Universal Time)\nSPACE ACTIVE STATUS: true\nCAN Hana AUTO INITIATE MESSAGES in SPACE: true\nCAN Hana AUTO DIGEST MEMORIES in SPACE: false\n\nSPACE NAME: [TEMP]: Test Space\nSPACE DESCRIPTION: NA\nSPACE GOOGLE CHAT ID: spaces/AAAAomn9p20\nSPACE GOOGLE CHAT TYPE: GROUP_CHAT\nSPACE CREATED DATE IN GOOGLE CHAT: Sun Sep 08 2024 06:33:26 GMT+0000 (Coordinated Universal Time)\nSPACE ACTIVE STATUS: true\nCAN Hana AUTO INITIATE MESSAGES in SPACE: true\nCAN Hana AUTO DIGEST MEMORIES in SPACE: false\n\nSPACE NAME: [TEST] Hana testing\nSPACE DESCRIPTION: Everything about the testing of Hana bot\nSPACE GOOGLE CHAT ID: spaces/AAAAyvKje9s\nSPACE GOOGLE CHAT TYPE: GROUP_CHAT\nSPACE CREATED DATE IN GOOGLE CHAT: Tue Mar 26 2024 09:20:30 GMT+0000 (Coordinated Universal Time)\nSPACE ACTIVE STATUS: true\nCAN Hana AUTO INITIATE MESSAGES in SPACE: true\nCAN Hana AUTO DIGEST MEMORIES in SPACE: false\n\nSPACE NAME: Hana Test Group\nSPACE DESCRIPTION: NA\nSPACE GOOGLE CHAT ID: spaces/AAAAzu2E6Rg\nSPACE GOOGLE CHAT TYPE: GROUP_CHAT\nSPACE CREATED DATE IN GOOGLE CHAT: Tue Jan 16 2024 19:46:41 GMT+0000 (Coordinated Universal Time)\nSPACE ACTIVE STATUS: true\nCAN Hana AUTO INITIATE MESSAGES in SPACE: false\nCAN Hana AUTO DIGEST MEMORIES in SPACE: false"
  }
}

Get Users​

info

Retrieve a paginated list of users, optionally filtered by a search query on email or display name.

Request Type​

GET

Endpoint​

https://hana-api.hanabitech.com/v1/expose-api/users?page={{PAGE_NUMBER}}&per_page={{PAGE_NUMBER_LIMIT}}&search={{SEARCH_QUERY}}

Request Params​

  • search: string - optional

    • Filters the result for a particular search string against email and displayName.

  • per_page: number - optional

    • The number of records to fetch per page
    • Defaults to 10

  • page: number - optional

    • The page number starting from 1
    • Defaults to 1

cURL Example​

curl -G "https://hana-api.hanabitech.com/v1/expose-api/users" -H "Content-Type: application/json" -H "X-API-KEY: HANA-e0b1234567890abcdef1234567890abcdef1234567890abcdef1234" --data-urlencode "page=1" --data-urlencode "per_page=10"

Response​

A successful response returns HTTP 200 OK with this JSON structure:

{
"success": true,
"content": {
  "data": [
    {
      "_id": "67f7c8883e04132345789",
      "userID": "users/114902207647471234567",
      "email": "sagar@hanabitech.com",
      "displayName": "Sagar Kapoor",
      "role": "USER",
      "designation": null,
      "isActive": true,
      "organizationId": "67f4d7483fd123456789",
      "profilePicture": "https://lh3.googleusercontent.com/a/ACg8ocKr-RtvR-g1botUfoubEgQ1234567897=s512-c",
      "createdAt": "2025-04-10T13:32:56.847Z",
      "updatedAt": "2025-04-10T13:32:56.847Z",
      "updatedBy": "67f7c8883e01234578979",
      "__v": 0
    },
    {
      "_id": "67f4d7493fd0012345789",
      "userID": "users/1026064229123457894",
      "email": "santhosh.kumar@hanabitech.com",
      "displayName": "Santhosh Kumar",
      "role": "ADMIN",
      "designation": "Full Stack Developer",
      "isActive": true,
      "organizationId": "67f4d7483fd012356",
      "profilePicture": "https://lh3.googleusercontent.com/a/ACg8ocKr-RtvR-g1bot12331foubEgQ1234567897=s512-c",
      "createdAt": "2025-04-08T07:59:05.601Z",
      "updatedAt": "2025-05-13T16:25:01.365Z",
      "updatedBy": "67f4d7493fd0123456489",
      "__v": 0
    }
  ],
  "totalCount": 2
}
}