Hashtags

Hashtag related APIs

Knowledge Base Auto Hashtag Feedback (Classification)

post

This API lets you approve or decline classification hashtags for documents

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

Responses

200

Auto hashtag feedback submitted successfully

application/json

400

Invalid parameters

post

/webapi/kb_auto_hashtag_feedback

HTTPcURLJavaScriptPython

POST /webapi/kb_auto_hashtag_feedback HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "autoHashtagFeedbacks": [
    {
      "id": "text",
      "state": "text"
    }
  ]
}

{
  "result": [
    {
      "id": "text",
      "state": "text"
    }
  ]
}

Get All Hashtags

get

Gets all hashtags from both FAQs and Knowledge Bases with their usage counts

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

Successfully retrieved hashtags

application/json

get

/webapi/hashtags

HTTPcURLJavaScriptPython

GET /webapi/hashtags HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

Successfully retrieved hashtags

{
  "result": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

Knowledge Base Auto Hashtag (Classification)

post

This API lets you get the hashtag list with classification keywords for the documents

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

idsarrayOptional

The document ids you want to retrieve auto hashtags for

Responses

200

Auto hashtags retrieved successfully

application/json

400

Invalid parameters

post

/webapi/kb_auto_hashtag

HTTPcURLJavaScriptPython

POST /webapi/kb_auto_hashtag HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "ids": []
}

{
  "result": {
    "updated": [
      {
        "id": "text",
        "autoHashtags": [
          {
            "id": "text",
            "state": "text",
            "bestConfidence": 1,
            "autoHashtag": {
              "hashtag": "text"
            }
          }
        ]
      }
    ]
  },
  "errors": {}
}