> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hq.zone/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a help article (operator)

> `POST /v1/help/articles` - create a new article. Operator-only. The new row
is chunked + embedded + indexed before this returns.



## OpenAPI

````yaml POST /v1/help/articles
openapi: 3.1.0
info:
  title: HQ API
  description: >-
    Public HTTP API for HQ. Authenticate with a Personal Access Token
    (`Authorization: Bearer hq_pat_...`) for server-side integrations, or an
    OAuth 2.1 authorization-code + PKCE flow for browser apps acting on a user's
    behalf. Both grant from the same resource:action scope vocabulary; an
    endpoint's required scope is listed under its `security`.
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 1.0.0
servers:
  - url: https://api.hq.zone
    description: HQ API (production)
security: []
tags:
  - name: me
    description: The signed-in user's own account
  - name: conversations
    description: Conversations and their messages
  - name: documents
    description: The content-addressed documents library
  - name: schedules
    description: Scheduled prompts and recurring tasks
  - name: agents
    description: Agents, their skills and integrations
  - name: memory
    description: What the assistant remembers (L5 governance)
  - name: tokens
    description: Personal Access Token management
  - name: billing
    description: Usage and billing
  - name: notifications
    description: In-app notification center
  - name: admin
    description: Workspace administration
  - name: integrations
    description: Workspace integrations (Slack, MCP, skills)
  - name: onboarding
    description: New-workspace onboarding wizard
  - name: auth
    description: Sign-in, sessions, and OAuth
paths:
  /v1/help/articles:
    post:
      tags:
        - help
      summary: Create a help article (operator)
      description: >-
        `POST /v1/help/articles` - create a new article. Operator-only. The new
        row

        is chunked + embedded + indexed before this returns.
      operationId: help_create_article
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHelpReq'
        required: true
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Article'
        '403':
          description: Operator access required
        '409':
          description: Slug already exists
      security:
        - cookie_session: []
components:
  schemas:
    CreateHelpReq:
      type: object
      required:
        - slug
        - title
        - category
        - body
      properties:
        body:
          type: string
        category:
          type: string
        ord:
          type: integer
          format: int32
        slug:
          type: string
        summary:
          type: string
        title:
          type: string
    Article:
      type: object
      required:
        - slug
        - title
        - category
        - ord
        - summary
        - body
      properties:
        body:
          type: string
        category:
          type: string
        ord:
          type: integer
          format: int32
        slug:
          type: string
        summary:
          type: string
        title:
          type: string
  securitySchemes:
    cookie_session:
      type: apiKey
      in: cookie
      name: hq-session
      description: >-
        Browser session cookie set by sign-in. Web SPA only; not for PAT/OAuth
        integrators.

````