> ## 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 source

> Creates and ingests a new API context source. Provide a URL or pasted content.



## OpenAPI

````yaml /openapi.json post /api/v1/sources
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/sources:
    post:
      tags:
        - Sources
      summary: Create source
      description: >-
        Creates and ingests a new API context source. Provide a URL or pasted
        content.
      operationId: createSource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSourceRequest'
            example:
              type: openapi
              name: Public API
              url: https://api.example.com/openapi.json
      responses:
        '201':
          description: Source created and ingested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestionResultResponse'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    CreateSourceRequest:
      type: object
      properties:
        type:
          type: string
          enum:
            - auto
            - openapi
            - json
            - url
            - website
            - text
            - graphql
            - postman
            - asyncapi
            - grpc
            - soap
            - github
          default: auto
        name:
          type: string
          maxLength: 200
        url:
          type: string
          maxLength: 2000
        content:
          type: string
          maxLength: 2000000
      anyOf:
        - required:
            - url
        - required:
            - content
      additionalProperties: false
    IngestionResultResponse:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/SourceSummary'
        counts:
          type: object
          properties:
            chunks:
              type: integer
            documents:
              type: integer
            endpoints:
              type: integer
          additionalProperties: false
        documents:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              kind:
                type:
                  - string
                  - 'null'
              title:
                type:
                  - string
                  - 'null'
            additionalProperties: false
        endpoints:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              method:
                type:
                  - string
                  - 'null'
              path:
                type:
                  - string
                  - 'null'
            additionalProperties: false
      additionalProperties: false
    SourceSummary:
      type: object
      required:
        - id
        - name
        - object
        - status
        - type
        - createdAt
        - updatedAt
        - publicDocs
      properties:
        object:
          type: string
          const: source
        id:
          type: string
          format: uuid
        name:
          type: string
        type:
          type: string
          enum:
            - openapi
            - json
            - url
            - website
            - text
            - graphql
            - postman
            - asyncapi
            - grpc
            - soap
            - github
            - notion
            - confluence
            - hubspot
        status:
          type: string
          enum:
            - pending
            - processing
            - ready
            - failed
        inputUrl:
          type:
            - string
            - 'null'
        error:
          type:
            - string
            - 'null'
        auth:
          $ref: '#/components/schemas/SourceAuth'
        publicDocs:
          $ref: '#/components/schemas/PublicDocsMetadata'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
      additionalProperties: false
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - code
        - error
      properties:
        code:
          type: string
        error:
          type: string
    SourceAuth:
      type: object
      properties:
        configured:
          type: boolean
        hasSecret:
          type: boolean
        lastError:
          type:
            - string
            - 'null'
        lastVerifiedAt:
          type:
            - string
            - 'null'
          format: date-time
        status:
          type: string
        type:
          type:
            - string
            - 'null'
      additionalProperties: false
    PublicDocsMetadata:
      type: object
      properties:
        enabled:
          type: boolean
        published:
          type: boolean
        slug:
          type:
            - string
            - 'null'
        url:
          type:
            - string
            - 'null'
      additionalProperties: true
  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.
    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

````