Skip to content

Repository API

Manage knowledge repositories that store documents for RAG-powered AI agents.

List Repositories

Retrieve all repositories accessible to your account.

Endpoint: GET /repositories

Query Parameters

Parameter Type Required Description
filters object No Filter repositories by criteria
fields array No Specify fields to return
pagination object No Pagination settings (page, pageSize)
sort string No Sort order (e.g., "createdAt:desc")
locale string No Locale to apply

Example

curl "https://PLATFORM-URL-PLACEHOLDER/v1/api/repositories" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": {
    "repositories": [
      {
        "id": "repo_abc123",
        "name": "Product Documentation",
        "description": "All product docs and guides",
        "documentCount": 150,
        "createdAt": "2025-01-01T00:00:00Z",
        "updatedAt": "2025-01-20T00:00:00Z"
      }
    ],
    "pagination": {
      "total": 5,
      "page": 1,
      "pageSize": 25
    }
  },
  "error": null
}

Filter Repositories

Use filters to find specific repositories:

curl "https://PLATFORM-URL-PLACEHOLDER/v1/api/repositories?filters[name][$contains]=Product" \
  -H "Authorization: Bearer YOUR_API_KEY"

Pagination

curl "https://PLATFORM-URL-PLACEHOLDER/v1/api/repositories?pagination[page]=1&pagination[pageSize]=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sorting

Sort repositories by creation date, update date, or name:

curl "https://PLATFORM-URL-PLACEHOLDER/v1/api/repositories?sort=createdAt:desc" \
  -H "Authorization: Bearer YOUR_API_KEY"

Best Practices

  1. Cache Repository IDs: Store repository IDs to avoid repeated lookups
  2. Use Filters: Filter repositories by name or metadata when you have many
  3. Pagination: Use pagination for accounts with many repositories
  4. Monitor Document Counts: Track documentCount to manage repository size