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

# Create issue

> Creates a workspace-scoped support issue.


## OpenAPI

````yaml /openapi.json post /api/v1/issues
openapi: 3.1.0
info:
  title: Woes REST API
  summary: >-
    Public REST API for Woes workspace conversations, issues, clients, agents,
    sources, definitions, usage, and analytics.
  description: >-
    Use workspace API keys to work with Woes support conversations, messages,
    issues, client account aggregates, public agent metadata, API context
    sources, workspace definitions, usage meters, and sanitized analytics from
    server-side integrations.
  version: '2026-06-29'
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://woes.dev
    description: Production
security:
  - workspaceApiKey: []
tags:
  - name: Conversations
    description: Create, read, update, and message support conversations.
  - name: Issues
    description: Create, read, and update support issues.
  - name: Clients
    description: Read client account aggregates derived from workspace conversations.
  - name: Agents
    description: Read named support agent metadata and public widget keys.
  - name: Sources
    description: Create, inspect, update, delete, and rescan API context sources.
  - name: Definitions
    description: Read workspace tags, statuses, priorities, and custom field definitions.
  - name: Usage
    description: Read current-month public API and live API check usage.
  - name: Analytics
    description: Read sanitized workspace analytics aggregates.
paths:
  /api/v1/issues:
    post:
      tags:
        - Issues
      summary: Create issue
      description: Creates a workspace-scoped support issue.
      operationId: createIssue
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateIssueRequest'
            examples:
              createIssue:
                value:
                  subject: OAuth redirect URI mismatch
                  description: >-
                    Customer reports a redirect_uri mismatch on the production
                    OAuth app.
                  priority: high
                  customer:
                    name: Ada Lovelace
                    email: ada@example.com
                    company: Example API Co
                  tags:
                    - oauth
                    - production
            example:
              subject: OAuth redirect URI mismatch
              description: >-
                Customer reports a redirect_uri mismatch on the production OAuth
                app.
              priority: high
              statusCategory: new
              sourceChannel: api
              customer:
                name: Ada Lovelace
                email: ada@example.com
                company: Example API Co
              tags:
                - oauth
                - production
      responses:
        '201':
          description: Issue created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueResponse'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    CreateIssueRequest:
      type: object
      additionalProperties: false
      required:
        - subject
      properties:
        customer:
          $ref: '#/components/schemas/IssueCustomer'
        description:
          type: string
          maxLength: 8000
        priority:
          type: string
          minLength: 1
          maxLength: 32
          default: medium
        sourceChannel:
          type: string
          minLength: 1
          maxLength: 80
          default: api
        sourceConversationId:
          type: string
          format: uuid
        statusCategory:
          $ref: '#/components/schemas/IssueStatusCategory'
          default: new
        subject:
          type: string
          minLength: 1
          maxLength: 180
        tags:
          type: array
          maxItems: 25
          items:
            type: string
            minLength: 1
            maxLength: 64
          default: []
      example:
        subject: OAuth redirect URI mismatch
        description: Customer reports a redirect_uri mismatch on the production OAuth app.
        priority: high
        statusCategory: new
        sourceChannel: api
        customer:
          name: Ada Lovelace
          email: ada@example.com
          company: Example API Co
        tags:
          - oauth
          - production
    IssueResponse:
      type: object
      additionalProperties: false
      required:
        - issue
      properties:
        issue:
          $ref: '#/components/schemas/Issue'
    IssueCustomer:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
          maxLength: 160
        email:
          type:
            - string
            - 'null'
          format: email
          maxLength: 320
        company:
          type: string
          maxLength: 160
    IssueStatusCategory:
      type: string
      enum:
        - new
        - on_you
        - on_customer
        - on_hold
        - closed
    Issue:
      type: object
      additionalProperties: false
      required:
        - object
        - id
        - subject
        - preview
        - description
        - statusCategory
        - priority
        - tags
        - customer
        - source
        - createdAt
        - updatedAt
        - lastActivityAt
        - closedAt
      properties:
        object:
          type: string
          const: issue
        id:
          type: string
        subject:
          type: string
        preview:
          type: string
        description:
          type: string
        statusCategory:
          $ref: '#/components/schemas/IssueStatusCategory'
        priority:
          type: string
        tags:
          type: array
          items:
            type: string
        customer:
          $ref: '#/components/schemas/IssueCustomer'
        source:
          $ref: '#/components/schemas/IssueSource'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        lastActivityAt:
          type: string
          format: date-time
        closedAt:
          type:
            - string
            - 'null'
          format: date-time
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - code
        - error
      properties:
        code:
          type: string
        error:
          type: string
    IssueSource:
      type: object
      additionalProperties: false
      required:
        - channel
        - conversationId
      properties:
        channel:
          type:
            - string
            - 'null'
        conversationId:
          type:
            - string
            - 'null'
  responses:
    InvalidRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidRequest:
              value:
                code: invalid_request
                error: Request body is invalid.
    Unauthorized:
      description: Missing, unknown, revoked, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                code: unauthorized
                error: A valid workspace API key is required.
    InsufficientScope:
      description: API key does not include the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientScope:
              value:
                code: insufficient_scope
                error: This API key is missing the required scope.
    NotFound:
      description: Record not found in the API key workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notFound:
              value:
                code: not_found
                error: Record not found.
    Conflict:
      description: Record conflicts with an existing workspace record.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            conflict:
              value:
                code: conflict
                error: A record with this identifier already exists.
    RateLimited:
      description: Too many API requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                code: rate_limited
                error: Too many API requests. Slow down and try again shortly.
    InternalError:
      description: Unexpected API failure.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              value:
                code: internal_error
                error: The API request could not be completed.
  securitySchemes:
    workspaceApiKey:
      type: http
      scheme: bearer
      description: >-
        Workspace API key that starts with woesk_. Paste your own key into the
        docs playground; never expose it in browser code.
      x-default: woesk_your_api_key_here

````