Knowledge base'leri listele

Bir workspace API anahtarının zaten kullanabileceği Knowledge base'leri listeleyin

API anahtarının zaten kullanabileceği Knowledge base'leri listeler. Yükleme, arama veya erişim yönetiminden önce id, ad, rol ve dosya sayılarını keşfetmek için bu endpoint'i kullanın.

Başlamadan önce

API key scope: KNOWLEDGE_FOLDER_API kapsamına sahip bir API anahtarı gerekir. Bu listede Knowledge base almak için yalnızca workspace API anahtarları kullanılır. Personal key'ler boş liste döndürür. Kurulum için Share Knowledge bases with the API sayfasına bakın.
Knowledge bases: Knowledge Folder API, Library'de Knowledge base olarak görünen kaynakları yönetir.

Base URL

https://api.ajan.io

Dedicated deployments Tüm isteklerde api.ajan.com'u /api/public ile değiştirin.

Request Format

Query Parameters

Parameter	Type	Required	Description
`limit`	integer	No	Döndürülecek Knowledge base sayısı. Varsayılan: `50`. Minimum: `1`. Maksimum: `100`.
`cursor`	string	No	Önceki sayfadaki son Knowledge base'in UUID'si.

Bu endpoint Knowledge base'leri listeler, dosyaları değil. Bir Knowledge base içindeki dosyaları listelemek için Retrieve Files kullanın.

Examples

List Knowledge bases with cURL

bash

curl -X GET "https://api.ajan.io/knowledge?limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

List Knowledge bases with JavaScript

javascript

const axios = require("axios");

async function listKnowledgeBases(cursor) {
  const response = await axios.get("https://api.ajan.io/knowledge", {
    params: {
      limit: 50,
      cursor,
    },
    headers: {
      Authorization: "Bearer YOUR_API_KEY",
    },
  });

  return response.data;
}

const firstPage = await listKnowledgeBases();
console.log(`Found ${firstPage.result.folders.length} Knowledge bases`);

firstPage.result.folders.forEach((folder) => {
  console.log(`- ${folder.name} (${folder.role}, ${folder.fileCount} files)`);
});

Response Format

Success Response (200 OK)

typescript

{
  status: "success";
  result: {
    folders: Array<{
      id: string;                 // Knowledge base ID
      name: string;               // Knowledge base name
      description: string | null; // Knowledge base description
      createdAt: string;          // ISO 8601 timestamp
      updatedAt: string;          // ISO 8601 timestamp
      fileCount: number;          // Non-deleted files in the Knowledge base
      role: "USER" | "EDITOR";    // This key's role. USER is Viewer.
    }>;
    nextCursor?: string;          // Present when another page remains
  };
}

role, anahtarın açık Editor yetkisi olduğunda EDITOR'dür. Anahtarın açık Viewer yetkisi olduğunda veya Knowledge base açık anahtar yetkisi olmadan API aramasına izin verdiğinde USER'dır.

Sonuçlar createdAt azalan, ardından id azalan sırada döner.

Example Response

json

{
  "status": "success",
  "result": {
    "folders": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Product handbook",
        "description": "Internal product documentation",
        "createdAt": "2026-08-12T09:15:00.000Z",
        "updatedAt": "2026-08-28T14:02:00.000Z",
        "fileCount": 12,
        "role": "EDITOR"
      },
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "name": "Support articles",
        "description": null,
        "createdAt": "2026-07-03T11:00:00.000Z",
        "updatedAt": "2026-08-01T16:40:00.000Z",
        "fileCount": 48,
        "role": "USER"
      }
    ],
    "nextCursor": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }
}

Error Handling

Status	Meaning
`400`	Geçersiz `limit` veya `cursor`
`401`	Geçersiz veya eksik API anahtarı
`403`	Eksik `KNOWLEDGE_FOLDER_API` kapsamı
`429`	Rate limit aşıldı
`500`	Beklenmeyen sunucu hatası

Bilinmeyen bir cursor "Invalid cursor" ile 400 döndürür.

Knowledge base oluşturmak veya silmek için genel bir endpoint yoktur.

ajan, API anahtarınızı korumak ve uygulamalarınızın güvenliğini sağlamak için tarayıcı kaynaklı istekleri bilinçli olarak engeller. Daha fazla bilgi için API Key Best Practices kılavuzuna bakın.

OpenAPI

openapi: 3.0.0
info:
  title: ajan API
  version: 3.0.0
servers:
  - url: https://api.ajan.io
    description: Production
security:
  - bearerAuth: []
paths:
  /knowledge:
    get:
      summary: List Knowledge bases accessible to the API key
      parameters:
        - name: limit
          in: query
          required: false
          description: Number of Knowledge bases to return. Default 50. Maximum 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: cursor
          in: query
          required: false
          description: UUID of the last Knowledge base from the previous page
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Knowledge bases retrieved successfully
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key as Bearer token. Format "Bearer YOUR_API_KEY"