> ## Documentation Index > Fetch the complete documentation index at: https://docs.open.cx/llms.txt > Use this file to discover all available pages before exploring further. > Create a help center article as a draft in the primary language under a category. Publish it separately to make it live and available to the AI. # Create a help center article ## OpenAPI ````yaml post /hc/{helpCenterId}/articles openapi: 3.1.0 info: title: OpenCX API description: > OpenCX is an AI-powered, all-in-one platform for customer support and outbound communications. Use this API to manage your OpenCX organization's AI agents, actions, conversations, contacts, and more. To get started, generate a new API key from the dashboard. ## Authentication All API endpoints require authentication using a Bearer token. You can generate an API key from your OpenCX dashboard. ## Rate Limiting API requests are rate limited to ensure fair usage. The current limits are: - 100 requests per minute for standard endpoints - 1000 requests per minute for streaming endpoints ## Error Handling The API uses standard HTTP status codes and returns detailed error messages in the response body. version: 1.0-beta license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: http://localhost:8080 description: Development - url: https://api.open.cx description: Production security: - bearerAuth: [] paths: /hc/{helpCenterId}/articles: post: summary: Create a help center article description: >- Create an article draft in the primary language under the given topic. The article is NOT published until you call the publish endpoint. operationId: createHelpCenterArticle parameters: - schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: path name: helpCenterId required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePublicArticleDto' responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/CreateArticleResponseDto' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDto' components: schemas: CreatePublicArticleDto: $schema: https://json-schema.org/draft/2020-12/schema $id: '#/components/schemas/CreatePublicArticleDtoInput' type: object properties: category_entity_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ title: type: string minLength: 1 slug: type: string content_html: description: >- Article body as an HTML fragment. Embed a video with `
`, where `data-embed` is `youtube`, `vimeo`, `loom` or `wistia`; iframes are removed. type: string meta_title: type: string meta_description: type: string language_code: description: >- Language the article is written in; defaults to the help center’s primary language. Must be one of the help center’s languages. type: string required: - category_entity_id - title additionalProperties: false CreateArticleResponseDto: $schema: https://json-schema.org/draft/2020-12/schema $id: '#/components/schemas/CreateArticleResponseDto' type: object properties: entity: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ help_center_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ category_entity_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ source_language_code: type: string created_at: type: string format: date-time required: - id - help_center_id - category_entity_id - source_language_code - created_at additionalProperties: false sourceVersion: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ entity_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ version_number: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' content_html: anyOf: - type: string - type: 'null' meta_title: anyOf: - type: string - type: 'null' meta_description: anyOf: - type: string - type: 'null' generated_from_session_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' created_at: type: string format: date-time is_active: anyOf: - type: boolean - type: 'null' required: - id - entity_id - version_number - content_html - meta_title - meta_description - generated_from_session_id - created_at - is_active additionalProperties: false primaryLocale: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ source_version_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ entity_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ help_center_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ language_code: type: string title: type: string slug: type: string content_html: anyOf: - type: string - type: 'null' is_manual: anyOf: - type: boolean - type: 'null' translated_from_locale_version_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' created_at: type: string format: date-time is_published: anyOf: - type: boolean - type: 'null' published_at: anyOf: - type: string format: date-time - type: 'null' required: - id - source_version_id - entity_id - help_center_id - language_code - title - slug - content_html - is_manual - translated_from_locale_version_id - created_at - is_published - published_at additionalProperties: false required: - entity - sourceVersion - primaryLocale additionalProperties: false ErrorDto: type: object properties: statusCode: type: integer message: type: string error: type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.