communicate-so Learnings API

openapi: 3.2.0
info:
  title: Communicate So Learnings API
  version: 0.1.5
  description: 'Operations tagged Learnings across 2 of this provider''s published API definitions: communicate-so-openapi.json, communicate-so-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.communicate.so/api/v1
  description: Canonical external base URL served through the Next.js /api/v1 rewrite.
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Learnings
paths:
  /workspaces/{workspaceId}/agents/{agentId}/learnings:
    get:
      operationId: listLearnings
      summary: Review captured learning candidates and publication state
      description: Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.
      tags:
      - Learnings
      security:
      - accountBearer: []
      - accountSession: []
      - localAccountSession: []
      x-required-account-scopes:
      - learnings:read
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: agentId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      responses:
        '200':
          description: Review captured learning candidates and publication state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/listLearningsResponse'
        '401':
          description: Missing, invalid, expired or revoked account credential or application session.
        '402':
          description: Plan entitlement, capacity or credits do not allow this operation.
        '403':
          description: Required account scope, live verified identity, membership or role permission is missing.
        '404':
          description: Workspace or addressed resource is not visible to this member.
        '409':
          description: Support handle, source URL or pending transfer conflicts with this operation.
        '422':
          description: Website URL or extraction source is not supported.
        '429':
          description: Agent request or website crawl rate limit exceeded.
        '500':
          description: Unexpected server failure.
        '503':
          description: Authorization service temporarily unavailable.
    servers:
    - url: https://app.communicate.so/api/v1
      description: Canonical external base URL served through the Next.js /api/v1 rewrite.
  /workspaces/{workspaceId}/agents/{agentId}/learnings/{learningId}/approve:
    post:
      operationId: approveLearning
      summary: Approve captured knowledge using existing publication and conflict rules
      description: Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.
      tags:
      - Learnings
      security:
      - accountBearer: []
      - accountSession: []
      - localAccountSession: []
      x-required-account-scopes:
      - learnings:write
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: agentId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: learningId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      responses:
        '200':
          description: Approve captured knowledge using existing publication and conflict rules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/approveLearningResponse'
        '401':
          description: Missing, invalid, expired or revoked account credential or application session.
        '402':
          description: Plan entitlement, capacity or credits do not allow this operation.
        '403':
          description: Required account scope, live verified identity, membership or role permission is missing.
        '404':
          description: Workspace or addressed resource is not visible to this member.
        '409':
          description: Support handle, source URL or pending transfer conflicts with this operation.
        '422':
          description: Website URL or extraction source is not supported.
        '429':
          description: Agent request or website crawl rate limit exceeded.
        '500':
          description: Unexpected server failure.
        '503':
          description: Authorization service temporarily unavailable.
    servers:
    - url: https://app.communicate.so/api/v1
      description: Canonical external base URL served through the Next.js /api/v1 rewrite.
  /workspaces/{workspaceId}/agents/{agentId}/learnings/{learningId}/reject:
    post:
      operationId: rejectLearning
      summary: Reject captured knowledge using existing terminal and conflict rules
      description: Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.
      tags:
      - Learnings
      security:
      - accountBearer: []
      - accountSession: []
      - localAccountSession: []
      x-required-account-scopes:
      - learnings:write
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: agentId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      - name: learningId
        in: path
        required: true
        schema:
          type: string
          minLength: 1
      responses:
        '200':
          description: Reject captured knowledge using existing terminal and conflict rules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rejectLearningResponse'
        '401':
          description: Missing, invalid, expired or revoked account credential or application session.
        '402':
          description: Plan entitlement, capacity or credits do not allow this operation.
        '403':
          description: Required account scope, live verified identity, membership or role permission is missing.
        '404':
          description: Workspace or addressed resource is not visible to this member.
        '409':
          description: Support handle, source URL or pending transfer conflicts with this operation.
        '422':
          description: Website URL or extraction source is not supported.
        '429':
          description: Agent request or website crawl rate limit exceeded.
        '500':
          description: Unexpected server failure.
        '503':
          description: Authorization service temporarily unavailable.
    servers:
    - url: https://app.communicate.so/api/v1
      description: Canonical external base URL served through the Next.js /api/v1 rewrite.
components:
  schemas:
    rejectLearningResponse:
      type: object
      properties:
        ok:
          type: boolean
          const: true
      required:
      - ok
      additionalProperties: false
    listLearningsResponse:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
            minLength: 1
          question:
            type: string
          answer:
            type: string
          status:
            type: string
            enum:
            - pending
            - conflicted
            - published
            - superseded
            - rejected
          timesSeen:
            type: integer
            minimum: -9007199254740991
            maximum: 9007199254740991
          capturedAt:
            type: string
            format: date-time
            pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          supersedesId:
            anyOf:
            - type: string
              minLength: 1
            - type: 'null'
        required:
        - id
        - question
        - answer
        - status
        - timesSeen
        - capturedAt
        - supersedesId
        additionalProperties: false
    approveLearningResponse:
      type: object
      properties:
        ok:
          type: boolean
          const: true
      required:
      - ok
      additionalProperties: false
  securitySchemes:
    accountSession:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: Signed Better Auth session cookie for an HTTPS application origin. Credential management additionally requires verified email and fresh password proof on writes.
    localAccountSession:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Signed session cookie used when the configured application auth origin is HTTP, such as local development.
    accountBearer:
      type: http
      scheme: bearer
      bearerFormat: Account credential
      description: Opaque user-bound `ca_` account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace `ck_` key or OAuth access token.
    clientCredentialsBasic:
      type: http
      scheme: basic
      description: Use the API key ID as the username and the one-time `ck_` API key token as the password.
    oauth2:
      type: oauth2
      description: OAuth 2.0 client-credentials tokens bounded by the source API key scope ceiling.
      flows:
        clientCredentials:
          tokenUrl: https://app.communicate.so/api/v1/oauth/token
          scopes:
            agents:read: List agents in the authenticated workspace.
            chat:write: Create chat turns with an agent in the authenticated workspace.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Workspace API key token with the `ck_` prefix.
x-refined-from:
- communicate-so-openapi.json
- communicate-so-openapi.json