openapi: 3.2.0
info:
  description: The One API. Universal API integration platform for AI agents and applications.
  license:
    name: ''
  title: One Knowledge API
  version: 5.35.0
tags:
- description: Search knowledge base
  name: Knowledge
paths:
  /v1/knowledge:
    get:
      description: Returns knowledge documents — the per-action context the platform uses to ground LLM calls. Filter by platform or by a specific action to narrow the result.
      operationId: list_knowledge
      parameters:
      - in: query
        name: page
        required: true
        schema:
          $ref: '#/components/schemas/Page'
      - description: 'Filter by the connector / platform the knowledge document is attached

          to.'
        in: query
        name: connectionPlatform
        required: false
        schema:
          type: string
      - description: 'Filter by the action / system id (`_id` on the wire) the knowledge

          document is attached to.'
        in: query
        name: _id
        required: false
        schema:
          type: string
      - description: Selects the tenant this request acts in. Omit it to act in your personal scope.
        in: header
        name: X-One-Organization-Id
        required: false
        schema:
          format: uuid
          type: string
      - description: Selects the tenant this request acts in. Omit it to act in your personal scope.
        in: header
        name: X-One-Project-Id
        required: false
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paginated_KnowledgeView'
          description: Paginated list of knowledge items
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
      - X-Pica-Secret: []
      - OAuth2:
        - user:connections:read
      - OAuth2:
        - org:connections:read
      - OAuth2:
        - project:connections:read
      summary: List knowledge
      tags:
      - Knowledge
components:
  schemas:
    JsonSchema:
      properties:
        inputSchema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Value'
        ioExample:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/JsonSchemaExample'
        outputSchema:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Value'
      type: object
    Paginated_KnowledgeView:
      properties:
        page:
          format: int64
          minimum: 0
          type: integer
        pages:
          format: int64
          minimum: 0
          type: integer
        rows:
          items:
            properties:
              _id:
                type: string
              active:
                type: boolean
              baseUrl:
                type: string
              connectionPlatform:
                type: string
              id:
                $ref: '#/components/schemas/ConnectionModelDefinitionId'
              ioSchema:
                oneOf:
                - type: 'null'
                - $ref: '#/components/schemas/JsonSchema'
              knowledge:
                type:
                - string
                - 'null'
              method:
                $ref: '#/components/schemas/Method'
              path:
                type: string
              tags:
                items:
                  type: string
                type: array
              title:
                type: string
            required:
            - id
            - _id
            - connectionPlatform
            - title
            - path
            - method
            - baseUrl
            - tags
            - active
            type: object
          type: array
        total:
          format: int64
          minimum: 0
          type: integer
      required:
      - rows
      - total
      - pages
      - page
      type: object
    JsonSchemaExample:
      properties:
        input:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Value'
        output:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/Value'
      type: object
    Value: {}
    ErrorResponse:
      properties:
        correlationId:
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        key:
          example: http_error
          type: string
        message:
          example: Authentication required
          type: string
        status:
          example: 401
          format: int32
          minimum: 0
          type: integer
        type:
          example: http_error
          type: string
      required:
      - correlationId
      - key
      - message
      - type
      - status
      type: object
    Method:
      enum:
      - OPTIONS
      - GET
      - POST
      - PUT
      - DELETE
      - HEAD
      - TRACE
      - CONNECT
      - PATCH
      type: string
    Page:
      properties:
        limit:
          description: 'Items per page. Default 20, hard-capped at 150. `limit=0` is

            treated as 1. Larger values silently clamp.'
          format: int64
          minimum: 0
          type: integer
        page:
          description: Page number for pagination (1-indexed). Defaults to 1.
          format: int64
          minimum: 0
          type: integer
        skip:
          description: 'Number of items to skip before the first returned item. Defaults to 0.

            Most callers should leave this at 0 and rely on `page` + `limit`.'
          format: int64
          minimum: 0
          type: integer
      type: object
    ConnectionModelDefinitionId:
      description: Prefixed ID with 'conn_mod_def' prefix (e.g., 'conn_mod_def_1C'), also accepts raw integer
      type: string
  securitySchemes:
    Bearer:
      scheme: bearer
      type: http
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://api.withone.ai/oauth/authorize
          scopes:
            org:ai_skills:read: Read organization AI skills
            org:ai_skills:write: Create, update, and delete organization AI skills
            org:authkit:read: Read organization AuthKit resources
            org:authkit:write: Create, update, and delete organization AuthKit resources
            org:connections:read: Read organization connections
            org:connections:write: Create, update, and delete organization connections
            org:projects:read: Read organization projects
            org:projects:write: Create, update, and delete organization projects
            org:secrets:read: Read organization secrets
            org:secrets:write: Create, update, and delete organization secrets
            org:workflows:executions:read: Read organization workflow executions
            org:workflows:executions:write: Create, update, and delete organization workflow executions
            org:workflows:read: Read organization workflows
            org:workflows:write: Create, update, and delete organization workflows
            project:ai_skills:read: Read project AI skills
            project:ai_skills:write: Create, update, and delete project AI skills
            project:authkit:read: Read project AuthKit resources
            project:authkit:write: Create, update, and delete project AuthKit resources
            project:connections:read: Read project connections
            project:connections:write: Create, update, and delete project connections
            project:secrets:read: Read project secrets
            project:secrets:write: Create, update, and delete project secrets
            project:workflows:executions:read: Read project workflow executions
            project:workflows:executions:write: Create, update, and delete project workflow executions
            project:workflows:read: Read project workflows
            project:workflows:write: Create, update, and delete project workflows
            user:ai_skills:read: Read your personal AI skills
            user:ai_skills:write: Create, update, and delete your personal AI skills
            user:authkit:read: Read your personal AuthKit resources
            user:authkit:write: Create, update, and delete your personal AuthKit resources
            user:connections:read: Read your personal connections
            user:connections:write: Create, update, and delete your personal connections
            user:secrets:read: Read your personal secrets
            user:secrets:write: Create, update, and delete your personal secrets
            user:workflows:executions:read: Read your personal workflow executions
            user:workflows:executions:write: Create, update, and delete your personal workflow executions
            user:workflows:read: Read your personal workflows
            user:workflows:write: Create, update, and delete your personal workflows
          tokenUrl: https://api.withone.ai/oauth/token
      type: oauth2
    Session:
      in: cookie
      name: withone
      type: apiKey
    X-One-Connection-Key:
      in: header
      name: X-One-Connection-Key
      type: apiKey
    X-One-Secret:
      in: header
      name: X-One-Secret
      type: apiKey
    X-Pica-Connection-Key:
      in: header
      name: X-One-Connection-Key
      type: apiKey
    X-Pica-Secret:
      in: header
      name: X-One-Secret
      type: apiKey