> ## 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. # Create tag > Create a tag on the parent organization. An organization can have up to 100 tags. Add the tag to a tag group and apply the group to a bot to start using it. ## OpenAPI ````yaml /openapi/openapi.yaml post /organizations/{orgId}/tags 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: /organizations/{orgId}/tags: post: tags: - Tags summary: Create tag description: >- Create a tag on the parent organization. An organization can have up to 100 tags. Add the tag to a tag group and apply the group to a bot to start using it. operationId: postV1OrganizationsByOrgIdTags parameters: - name: orgId in: path required: true schema: format: uuid description: The ID of the parent organization that owns the tags type: string requestBody: description: Payload required to create a conversation tag required: true content: application/json: schema: $ref: '#/components/schemas/CreateConversationTagRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateConversationTagRequest' multipart/form-data: schema: $ref: '#/components/schemas/CreateConversationTagRequest' responses: '200': description: Response returned for a single tag content: application/json: schema: $ref: '#/components/schemas/ConversationTagDetailResponse' '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: CreateConversationTagRequest: additionalProperties: false type: object required: - name - classificationPrompt - direction properties: name: minLength: 1 maxLength: 100 pattern: \S description: Name of the tag. Must be unique within the organization. type: string displayName: minLength: 1 maxLength: 100 pattern: \S description: Label to show for this tag. Defaults to `name`. type: string classificationPrompt: minLength: 1 maxLength: 1000 pattern: \S description: >- Describes when this tag applies. At the end of each conversation, Annie checks the conversation against this text. Say what counts and what does not. type: string direction: type: string enum: - INBOUND - OUTBOUND - BOTH color: type: string enum: - gray - success - warn - error ConversationTagDetailResponse: additionalProperties: false type: object required: - success - data properties: success: enum: - true type: boolean data: additionalProperties: false description: A tag Annie can apply to a conversation when it ends type: object required: - id - name - displayName - classificationPrompt - direction - color - orgId - createdAt - updatedAt properties: id: format: uuid type: string name: type: string displayName: type: string classificationPrompt: type: string direction: type: string enum: - INBOUND - OUTBOUND - BOTH color: type: string enum: - gray - success - warn - error orgId: 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.