> ## Documentation Index > Fetch the complete documentation index at: https://docs.helloannie.com/llms.txt > Use this file to discover all available pages before exploring further. # Set a bot's tag groups > Replace the tag groups applied to a bot. A bot can use groups from its own organization or its parent, with up to 25 tags in total. Each tag is checked at the end of every conversation on this bot, and matches appear in `metadata.tags` on the `conversation.ended` webhook and in `tags` on the conversation. Any tags otherwise set up for the bot's organization keep running alongside these groups. ## OpenAPI ````yaml /openapi/openapi.yaml post /bots/{botId}/tag-groups openapi: 3.0.3 info: title: Annie API description: > ### Overview The Annie API is a (mostly) RESTful API. Typically, both POST bodies and responses are JSON-encoded. Note: The documenation is Work In Progress and is subject to change. ### Base URL The base URL for the Annie API is https://api.helloannie.com/. Examples in this document may abbreviate this to `/`. ### Versioning Routes are prefixed with a version number i.e. `v1`. The version will change when there is a non-backwards compatible or other significant change to the api. ### Authentication The Annie API supports two authentication methods API Keys and OAuth Access Tokens: #### API Keys API Keys are long-lived tokens that can be generated from the Developer Portal on your organization page. API keys are prefixed with `annie-sk-v2-` and can be used directly in the `Authorization` header. ``` curl -H "Authorization: Bearer annie-sk-v2-xxxxx" https://api.helloannie.com/... ``` #### OAuth Tokens OAuth tokens are short-lived access tokens generated using the OAuth 2.0 Client Credentials flow (Machine-to-Machine). OAuth clients provide scoped permissions and are ideal for server-to-server integrations. **Creating an OAuth Client** OAuth clients can be created in the Developer Portal on your organization page. When creating a client, you'll receive: - `client_id`: Your OAuth client identifier - `client_secret`: Your OAuth client secret (store this securely) **Generating an OAuth Token** To generate an OAuth access token, make a POST request to the Annie OAuth token endpoint: **Endpoint:** `https://annie-external-api.us.auth0.com/oauth/token` **Example Request:** ```bash curl -X POST https://annie-external-api.us.auth0.com/oauth/token \ -H "Content-Type: application/json" \ -d '{ "grant_type": "client_credentials", "client_id": "your-client-id", "client_secret": "your-client-secret", "audience": "https://api.helloannie.com" }' ``` The `access_token` from the response should be used in the `Authorization` header when making requests to the Annie API: ``` curl -H "Authorization: Bearer eyJhbGciOiJSUzI..." https://api.helloannie.com/v1/... ``` ### API Response Structure The Annie API returns status codes consistent with standard HTTP conventions. Success and Error responses follow the below structure: ``` { "success": boolean "data": {} "message": string // optional } ``` ### Rate Limiting The Annie API enforces rate limits to ensure stability and fair usage. The default rate limit is **60 requests per minute** per organization. This limit is applied per endpoint pattern (e.g. `GET /v1/bots/:id`). When the rate limit is exceeded, the API responds with HTTP `429 Too Many Requests`. Response headers include: - `X-RateLimit-Limit`: The maximum number of requests allowed in the current window. - `X-RateLimit-Remaining`: The number of requests remaining in the current window. - `X-RateLimit-Reset`: The time at which the current rate limit window resets (in UTC epoch seconds). If you exceed the limit, the response will contain a `Retry-After` header indicating how many seconds to wait before retrying. ### Pagination The Annie API does not currently support pagination. All results are returned at once. version: v1 servers: - url: https://api.helloannie.com/v1 security: - bearerAuth: [] paths: /bots/{botId}/tag-groups: post: tags: - Tag Groups summary: Set a bot's tag groups description: >- Replace the tag groups applied to a bot. A bot can use groups from its own organization or its parent, with up to 25 tags in total. Each tag is checked at the end of every conversation on this bot, and matches appear in `metadata.tags` on the `conversation.ended` webhook and in `tags` on the conversation. Any tags otherwise set up for the bot's organization keep running alongside these groups. operationId: postV1BotsByBotIdTag-groups parameters: - name: botId in: path required: true schema: format: uuid description: The ID of the bot type: string requestBody: description: The tag groups to apply to a bot required: true content: application/json: schema: $ref: '#/components/schemas/UpdateBotTagGroupsRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateBotTagGroupsRequest' multipart/form-data: schema: $ref: '#/components/schemas/UpdateBotTagGroupsRequest' responses: '200': description: Response returned when listing tag groups content: application/json: schema: $ref: '#/components/schemas/TagGroupListResponse' '400': description: The request was invalid or malformed content: application/json: schema: $ref: '#/components/schemas/BadRequestResponse' '403': description: You do not have permission to perform this action content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' '404': description: The requested resource was not found content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '409': description: The request conflicts with another in-progress operation content: application/json: schema: $ref: '#/components/schemas/ConflictResponse' components: schemas: UpdateBotTagGroupsRequest: additionalProperties: false type: object required: - tagGroupIds properties: tagGroupIds: maxItems: 20 description: >- Tag groups this bot uses. Replaces the current list. Send an empty list to stop tagging with tag groups on this bot. type: array items: format: uuid type: string TagGroupListResponse: additionalProperties: false type: object required: - success - data properties: success: enum: - true type: boolean data: additionalProperties: false type: object required: - tagGroups properties: tagGroups: type: array items: additionalProperties: false description: >- A reusable set of conversation tags that can be applied to bots type: object required: - id - name - orgId - tagIds - createdAt - updatedAt properties: id: format: uuid type: string name: type: string orgId: format: uuid type: string tagIds: type: array items: format: uuid type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time BadRequestResponse: additionalProperties: false type: object required: - success - data - message properties: success: enum: - false type: boolean data: additionalProperties: false type: object properties: {} message: type: string ForbiddenResponse: additionalProperties: false type: object required: - success - data - message properties: success: enum: - false type: boolean data: additionalProperties: false type: object properties: {} message: type: string NotFoundResponse: additionalProperties: false type: object required: - success - data - message properties: success: enum: - false type: boolean data: additionalProperties: false type: object properties: {} message: type: string ConflictResponse: additionalProperties: false type: object required: - success - data - message properties: success: enum: - false type: boolean data: additionalProperties: false type: object properties: {} message: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key (annie-sk-v2-...) or an OAuth access token, sent as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.