# Hashtags

Hashtag related APIs

## Knowledge Base Auto Hashtag Feedback (Classification)

> This API lets you approve or decline classification hashtags for documents

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"Hashtags","description":"Hashtag related APIs"}],"servers":[{"url":"https://backend.alli.ai","description":"US"},{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"Your API key for authentication"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: Email of the agent to use for this request"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: Email address to associate with the user"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: User ID to identify or create a user"}}},"paths":{"/webapi/kb_auto_hashtag_feedback":{"post":{"tags":["Hashtags"],"operationId":"kbAutoHashtagFeedback","summary":"Knowledge Base Auto Hashtag Feedback (Classification)","description":"This API lets you approve or decline classification hashtags for documents","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoHashtagFeedbacks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the hashtag to update"},"state":{"type":"string","description":"The state to set for the hashtag. Can be one of 'accepted', 'declined', 'suggested'"}}}}}}}}},"responses":{"200":{"description":"Auto hashtag feedback submitted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the hashtag that was updated"},"state":{"type":"string","description":"The hashtag's new state. Will be one of \"suggested\", \"approved\", \"declined\""}}}}}}}}},"400":{"description":"Invalid parameters"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## Get All Hashtags

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

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"Hashtags","description":"Hashtag related APIs"}],"servers":[{"url":"https://backend.alli.ai","description":"US"},{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"Your API key for authentication"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: Email of the agent to use for this request"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: Email address to associate with the user"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: User ID to identify or create a user"}}},"paths":{"/webapi/hashtags":{"get":{"tags":["Hashtags"],"operationId":"getHashtags","summary":"Get All Hashtags","description":"Gets all hashtags from both FAQs and Knowledge Bases with their usage counts","responses":{"200":{"description":"Successfully retrieved hashtags","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","additionalProperties":{"type":"integer"},"description":"A mapping of hashtag names to their count of uses"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## Knowledge Base Auto Hashtag (Classification)

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

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"Hashtags","description":"Hashtag related APIs"}],"servers":[{"url":"https://backend.alli.ai","description":"US"},{"url":"https://backend-ja.alli.ai","description":"JA"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"Your API key for authentication"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: Email of the agent to use for this request"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: Email address to associate with the user"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"Optional: User ID to identify or create a user"}}},"paths":{"/webapi/kb_auto_hashtag":{"post":{"tags":["Hashtags"],"operationId":"kbAutoHashtag","summary":"Knowledge Base Auto Hashtag (Classification)","description":"This API lets you get the hashtag list with classification keywords for the documents","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"The document ids you want to retrieve auto hashtags for"}}}}}},"responses":{"200":{"description":"Auto hashtags retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Document to which the hashtags correspond"},"autoHashtags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the hashtag"},"state":{"type":"string","description":"Status of hashtag, one of \"SUGGESTED\", \"APPROVED\", \"DECLINED\""},"bestConfidence":{"type":"number","description":"Numerical confidence of this auto-generated hashtag from 0 to 1"},"autoHashtag":{"type":"object","properties":{"hashtag":{"type":"string","description":"String value of hashtag (displayed in Dashboard)"}}}}}}}}}}},"errors":{"type":"object","nullable":true}}}}}},"400":{"description":"Invalid parameters"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.allganize.ai/api-reference/hashtags.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.