{
  "openapi": "3.1.0",
  "info": {
    "title": "vybeflow API — knowledge",
    "version": "0.1.0",
    "description": "Setiap endpoint memerlukan API key tenant (Pengaturan → API Key di konsol vybeflow) dan hanya berjalan jika kunci itu mencakup izin yang tercantum pada x-vybeflow-scope. Permintaan dibatasi per kunci dan per tenant; setiap jawaban membawa header RateLimit-*, dan penolakan 429 membawa Retry-After."
  },
  "servers": [
    {
      "url": "https://vybeflow.vyber.id"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key",
        "description": "Kunci berformat vf_live_… Boleh juga dikirim sebagai Authorization: Bearer."
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "contact"
    },
    {
      "name": "campaign"
    },
    {
      "name": "inbox"
    },
    {
      "name": "channel"
    },
    {
      "name": "product"
    },
    {
      "name": "billing"
    },
    {
      "name": "tenant"
    },
    {
      "name": "knowledge"
    },
    {
      "name": "memory"
    }
  ],
  "paths": {
    "/api/ai-knowledge/v1/knowledge/search": {
      "post": {
        "operationId": "knowledge.search",
        "summary": "Cari pengetahuan tenant dari berkas dan memori. Jawabannya berupa blok konteks siap pakai untuk model.",
        "tags": [
          "knowledge"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-vybeflow-scope": "ai.config.read",
        "x-vybeflow-risk": "safe",
        "x-vybeflow-mcp-tool-only": "Di MCP, gunakan tool `search_knowledge`.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer"
                    },
                    "errorCode": {
                      "type": "integer"
                    },
                    "data": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "API key tidak berlaku, dicabut, atau kedaluwarsa"
          },
          "403": {
            "description": "Kunci tidak mencakup `ai.config.read`"
          },
          "429": {
            "description": "Batas permintaan terlampaui. Tunggu selama `Retry-After` detik lalu ulangi permintaan yang sama.",
            "headers": {
              "Retry-After": {
                "description": "Detik sampai permintaan ini bisa berhasil.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Limit": {
                "description": "Permintaan per menit untuk kunci ini.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Remaining": {
                "description": "Sisa token pada bucket.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Reset": {
                "description": "Detik sampai bucket penuh kembali.",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "prompt"
                ],
                "properties": {
                  "prompt": {
                    "type": "string",
                    "description": "Pertanyaan bahasa alami ATAU kata kunci telanjang — keduanya bekerja. Dipotong pada 4.000 karakter."
                  },
                  "limit_character": {
                    "type": "integer",
                    "description": "Maksimal karakter konteks yang dikembalikan. Default 20.000, rentang 500–100.000."
                  },
                  "audience": {
                    "type": "string",
                    "description": "'console' (default) ikut melihat sumber khusus staf; 'customer' hanya sumber ber-audience 'all'."
                  },
                  "kinds": {
                    "type": "array",
                    "description": "Batasi jenis sumber: 'file' dan/atau 'memory'."
                  },
                  "sourceIDs": {
                    "type": "array",
                    "description": "Batasi ke sumber tertentu. Maksimal 100."
                  },
                  "rerank": {
                    "type": "boolean",
                    "description": "Paksa cross-encoder reranker hidup atau mati. Default 'auto'."
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/ai-knowledge/v1/knowledge/sources": {
      "get": {
        "operationId": "knowledge.list",
        "summary": "Daftar pengetahuan tenant: berkas dan memori, dengan status pemrosesan dan keyakinan OCR. Beri kind=memory untuk memori saja.",
        "tags": [
          "knowledge"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-vybeflow-scope": "ai.config.read",
        "x-vybeflow-risk": "safe",
        "parameters": [
          {
            "name": "view",
            "in": "query",
            "required": false,
            "description": {
              "type": "string",
              "enum": [
                "active",
                "deleted"
              ],
              "description": "active (default) atau deleted."
            },
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": {
              "type": "string",
              "enum": [
                "file",
                "memory"
              ]
            },
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": {
              "type": "string",
              "enum": [
                "uploading",
                "queued",
                "processing",
                "ready",
                "failed"
              ]
            },
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "description": {
              "type": "string",
              "description": "Cari berdasarkan nama."
            },
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer"
                    },
                    "errorCode": {
                      "type": "integer"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "sourceID": {},
                          "kind": {},
                          "name": {},
                          "ext": {},
                          "size": {},
                          "ref": {},
                          "origin": {},
                          "status": {},
                          "progress": {},
                          "pageCount": {},
                          "chunkCount": {},
                          "ocr": {},
                          "error": {},
                          "localEdit": {},
                          "deletedAt": {},
                          "createdAt": {},
                          "updatedAt": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "API key tidak berlaku, dicabut, atau kedaluwarsa"
          },
          "403": {
            "description": "Kunci tidak mencakup `ai.config.read`"
          },
          "429": {
            "description": "Batas permintaan terlampaui. Tunggu selama `Retry-After` detik lalu ulangi permintaan yang sama.",
            "headers": {
              "Retry-After": {
                "description": "Detik sampai permintaan ini bisa berhasil.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Limit": {
                "description": "Permintaan per menit untuk kunci ini.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Remaining": {
                "description": "Sisa token pada bucket.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Reset": {
                "description": "Detik sampai bucket penuh kembali.",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "/api/ai-knowledge/v1/knowledge/sources/{sourceID}": {
      "get": {
        "operationId": "knowledge.get",
        "summary": "Detail satu sumber pengetahuan, termasuk ringkasan per halaman (metode baca dan keyakinan OCR).",
        "tags": [
          "knowledge"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-vybeflow-scope": "ai.config.read",
        "x-vybeflow-risk": "safe",
        "parameters": [
          {
            "name": "sourceID",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer"
                    },
                    "errorCode": {
                      "type": "integer"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "sourceID": {},
                          "kind": {},
                          "name": {},
                          "ext": {},
                          "size": {},
                          "ref": {},
                          "origin": {},
                          "status": {},
                          "progress": {},
                          "pageCount": {},
                          "chunkCount": {},
                          "ocr": {},
                          "error": {},
                          "localEdit": {},
                          "deletedAt": {},
                          "createdAt": {},
                          "updatedAt": {},
                          "content": {},
                          "pages": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "API key tidak berlaku, dicabut, atau kedaluwarsa"
          },
          "403": {
            "description": "Kunci tidak mencakup `ai.config.read`"
          },
          "429": {
            "description": "Batas permintaan terlampaui. Tunggu selama `Retry-After` detik lalu ulangi permintaan yang sama.",
            "headers": {
              "Retry-After": {
                "description": "Detik sampai permintaan ini bisa berhasil.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Limit": {
                "description": "Permintaan per menit untuk kunci ini.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Remaining": {
                "description": "Sisa token pada bucket.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Reset": {
                "description": "Detik sampai bucket penuh kembali.",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "knowledge.delete",
        "summary": "Hapus satu sumber pengetahuan beserta vektornya (dan berkasnya, kecuali dokumen ONT Pilot).",
        "tags": [
          "knowledge"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-vybeflow-scope": "ai.config.manage",
        "x-vybeflow-risk": "destructive",
        "parameters": [
          {
            "name": "sourceID",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer"
                    },
                    "errorCode": {
                      "type": "integer"
                    },
                    "data": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "API key tidak berlaku, dicabut, atau kedaluwarsa"
          },
          "403": {
            "description": "Kunci tidak mencakup `ai.config.manage`"
          },
          "429": {
            "description": "Batas permintaan terlampaui. Tunggu selama `Retry-After` detik lalu ulangi permintaan yang sama.",
            "headers": {
              "Retry-After": {
                "description": "Detik sampai permintaan ini bisa berhasil.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Limit": {
                "description": "Permintaan per menit untuk kunci ini.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Remaining": {
                "description": "Sisa token pada bucket.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Reset": {
                "description": "Detik sampai bucket penuh kembali.",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        },
        "description": "Berkas dan vektornya dihapus permanen; agen AI tidak lagi bisa membacanya. Dokumen dari ONT Pilot hanya ditandai terhapus dan bisa dikembalikan dari console."
      }
    },
    "/api/ai-knowledge/v1/knowledge/sources/{sourceID}/pages": {
      "get": {
        "operationId": "knowledge.pages",
        "summary": "Teks hasil baca satu berkas, per halaman (maks. 50 halaman per panggilan).",
        "tags": [
          "knowledge"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-vybeflow-scope": "ai.config.read",
        "x-vybeflow-risk": "safe",
        "parameters": [
          {
            "name": "sourceID",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": false,
            "description": {
              "type": "integer",
              "description": "Halaman awal, mulai 1."
            },
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": false,
            "description": {
              "type": "integer",
              "description": "Halaman akhir (maks. from + 49)."
            },
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer"
                    },
                    "errorCode": {
                      "type": "integer"
                    },
                    "data": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "API key tidak berlaku, dicabut, atau kedaluwarsa"
          },
          "403": {
            "description": "Kunci tidak mencakup `ai.config.read`"
          },
          "429": {
            "description": "Batas permintaan terlampaui. Tunggu selama `Retry-After` detik lalu ulangi permintaan yang sama.",
            "headers": {
              "Retry-After": {
                "description": "Detik sampai permintaan ini bisa berhasil.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Limit": {
                "description": "Permintaan per menit untuk kunci ini.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Remaining": {
                "description": "Sisa token pada bucket.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Reset": {
                "description": "Detik sampai bucket penuh kembali.",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "/api/ai-knowledge/v1/knowledge/status": {
      "get": {
        "operationId": "knowledge.status",
        "summary": "Kesiapan layanan pengetahuan: indeks pencarian, parser/OCR, embedder, antrean.",
        "tags": [
          "knowledge"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-vybeflow-scope": "ai.config.read",
        "x-vybeflow-risk": "safe",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer"
                    },
                    "errorCode": {
                      "type": "integer"
                    },
                    "data": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "API key tidak berlaku, dicabut, atau kedaluwarsa"
          },
          "403": {
            "description": "Kunci tidak mencakup `ai.config.read`"
          },
          "429": {
            "description": "Batas permintaan terlampaui. Tunggu selama `Retry-After` detik lalu ulangi permintaan yang sama.",
            "headers": {
              "Retry-After": {
                "description": "Detik sampai permintaan ini bisa berhasil.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Limit": {
                "description": "Permintaan per menit untuk kunci ini.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Remaining": {
                "description": "Sisa token pada bucket.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Reset": {
                "description": "Detik sampai bucket penuh kembali.",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    },
    "/api/ai-knowledge/v1/knowledge/sources/{sourceID}/reprocess": {
      "post": {
        "operationId": "knowledge.reprocess",
        "summary": "Proses ulang satu sumber (baca, potong, vektorkan lagi). Versi lama tetap dicari sampai versi baru siap.",
        "tags": [
          "knowledge"
        ],
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "x-vybeflow-scope": "ai.config.manage",
        "x-vybeflow-risk": "confirm",
        "parameters": [
          {
            "name": "sourceID",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer"
                    },
                    "errorCode": {
                      "type": "integer"
                    },
                    "data": {}
                  }
                }
              }
            }
          },
          "401": {
            "description": "API key tidak berlaku, dicabut, atau kedaluwarsa"
          },
          "403": {
            "description": "Kunci tidak mencakup `ai.config.manage`"
          },
          "429": {
            "description": "Batas permintaan terlampaui. Tunggu selama `Retry-After` detik lalu ulangi permintaan yang sama.",
            "headers": {
              "Retry-After": {
                "description": "Detik sampai permintaan ini bisa berhasil.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Limit": {
                "description": "Permintaan per menit untuk kunci ini.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Remaining": {
                "description": "Sisa token pada bucket.",
                "schema": {
                  "type": "integer"
                }
              },
              "RateLimit-Reset": {
                "description": "Detik sampai bucket penuh kembali.",
                "schema": {
                  "type": "integer"
                }
              }
            }
          }
        }
      }
    }
  }
}