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

# List sources

> Lists API context sources for the API key workspace.



## OpenAPI

````yaml /openapi.json get /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:
    get:
      tags:
        - Sources
      summary: List sources
      description: Lists API context sources for the API key workspace.
      operationId: listSources
      parameters:
        - $ref: '#/components/parameters/SourceStatus'
        - $ref: '#/components/parameters/SourceType'
        - $ref: '#/components/parameters/SourceLimit'
      responses:
        '200':
          description: Source list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceListResponse'
              examples:
                readySources:
                  value:
                    object: list
                    hasMore: false
                    sources:
                      - object: source
                        id: 5f6a7b8c-1111-4222-9333-123456789abc
                        name: Public API
                        type: openapi
                        status: ready
                        inputUrl: https://api.example.com/openapi.json
                        error: null
                        publicDocs:
                          published: true
                          slug: public-api
                          url: https://woes.dev/docs/public-api
                        createdAt: '2026-06-29T16:00:00.000Z'
                        updatedAt: '2026-06-29T16:01:00.000Z'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    SourceStatus:
      name: status
      in: query
      required: false
      description: Filter sources by ingestion status.
      schema:
        type: string
        enum:
          - pending
          - processing
          - ready
          - failed
    SourceType:
      name: type
      in: query
      required: false
      description: Filter sources by source type.
      schema:
        type: string
        enum:
          - auto
          - openapi
          - json
          - url
          - website
          - text
          - graphql
          - postman
          - asyncapi
          - grpc
          - soap
          - github
          - notion
          - confluence
          - hubspot
    SourceLimit:
      name: limit
      in: query
      required: false
      description: Maximum number of sources to return.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
  schemas:
    SourceListResponse:
      type: object
      required:
        - object
        - hasMore
        - sources
      properties:
        object:
          type: string
          const: list
        hasMore:
          type: boolean
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceSummary'
      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.
    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

````