Knowledge Hub Management APIs - repositories
UpdatedDownload OpenAPI Specification: Download
For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.
List repositories
List repositories with optional filtering.
Returns list of repositories with pagination, optional filtering, and knowledge base counts.
Defaults to ENABLED repositories; pass a status filter to see others. Results are
scoped to the caller's Boomi tenant via the token's account claim.
Required privileges: KNOWLEDGE_HUB_REPO_READ.
Authorizations:
query Parameters
| limit | integer (Limit) [ 1 .. 1000 ] Default: 50 Maximum results to return |
| offset | integer (Offset) >= 0 Default: 0 Pagination offset |
RepositoryStatus (string) or Status (null) (Status) Filter by repository status | |
RepositoryType (string) or Repository Type (null) (Repository Type) Filter by repository type | |
Name (string) or Name (null) (Name) Filter by repository name |
Responses
Response Schema: application/json
| total required | integer (Total) Total number of items matching filters |
| limit required | integer (Limit) Limit applied |
| offset required | integer (Offset) Offset applied |
required | Array of objects (Repositories) |
Response samples
- 200
- 422
{- "limit": 20,
- "offset": 0,
- "repositories": [
- {
- "created_at": "2026-01-15T10:30:00Z",
- "created_by": "admin@boomi.com",
- "description": "HR policy documents for the company wiki",
- "id": "00000000-0000-0000-0000-000000000001",
- "knowledge_base_count": 2,
- "name": "HR Policies",
- "repository_type": "managed",
- "status": "enabled",
- "updated_at": "2026-02-01T09:00:00Z",
- "updated_by": "admin@boomi.com"
}
], - "total": 1
}Create repository
Create a new repository.
Creates a repository with the given configuration. Status is automatically set to 'enabled' on creation. The repository is created under the caller's Boomi tenant.
Required privileges: KNOWLEDGE_HUB_REPO_WRITE.
Authorizations:
Request Body schema: application/jsonrequired
| name required | string (Name) [ 1 .. 255 ] characters |
| description required | string (Description) <= 1000 characters |
| repository_type required | string (RepositoryType) Enum: "owned" "managed" Valid types for Repository. |
VectorStoreConfig (object) or null |
Responses
Request samples
- Payload
{- "description": "HR policy documents for the company wiki",
- "name": "HR Policies",
- "repository_type": "managed"
}Response samples
- 201
- 422
{- "repository_id": "00000000-0000-0000-0000-000000000001",
- "status": "ok"
}Get repository
Get a repository by ID, including its knowledge base count.
Required privileges: KNOWLEDGE_HUB_REPO_READ.
Authorizations:
path Parameters
| repository_id required | string <uuid> (Repository Id) UUID of the repository |
Responses
Response Schema: application/json
| id required | string <uuid> (Id) |
| name required | string (Name) |
| repository_type required | string (RepositoryType) Enum: "owned" "managed" Valid types for Repository. |
| status required | string (RepositoryStatus) Enum: "draft" "enabled" "archived" Valid statuses for Repository. |
| created_at required | string <date-time> (Created At) |
| updated_at required | string <date-time> (Updated At) |
Description (string) or Description (null) (Description) | |
VectorStoreConfig (object) or null | |
Created By (string) or Created By (null) (Created By) | |
Updated By (string) or Updated By (null) (Updated By) | |
| knowledge_base_count | integer (Knowledge Base Count) Default: 0 |
Response samples
- 200
- 422
{- "created_at": "2026-01-15T10:30:00Z",
- "created_by": "admin@boomi.com",
- "description": "HR policy documents for the company wiki",
- "id": "00000000-0000-0000-0000-000000000001",
- "knowledge_base_count": 2,
- "name": "HR Policies",
- "repository_type": "managed",
- "status": "enabled",
- "updated_at": "2026-02-01T09:00:00Z",
- "updated_by": "admin@boomi.com"
}Update repository
Update a repository.
Only fields present in the request body are changed.
Required privileges: KNOWLEDGE_HUB_REPO_WRITE.
Authorizations:
path Parameters
| repository_id required | string <uuid> (Repository Id) UUID of the repository |
Request Body schema: application/jsonrequired
Name (string) or Name (null) (Name) | |
Description (string) or Description (null) (Description) |
Responses
Response Schema: application/json
| status | string (Status) Default: "ok" |
Request samples
- Payload
{- "description": "Updated title",
- "name": "HR Policies 2026"
}Response samples
- 200
- 422
{- "status": "ok"
}Delete repository
Archive a repository and cascade the archive to its Knowledge Bases.
Soft delete: the repository's status is set to 'archived' and it no longer appears in default listings, but the record is retained. Every non-archived child Knowledge Base (status='archived') is also archived and its index scheduled for deferred deletion (index_deletion_due_at = now + INDEX_DELETION_GRACE_HOURS) — the index itself is never touched here; the kh-worker sweep deletes it after the grace window elapses. Already-archived KBs are left untouched. One shared timestamp stamps the repository's own Deleted event, every cascaded KB's Deleted event, and every cascaded KB's index_deletion_due_at.
Required privileges: KNOWLEDGE_HUB_REPO_DELETE.
Authorizations:
path Parameters
| repository_id required | string <uuid> (Repository Id) UUID of the repository |
Responses
Response Schema: application/json
| repository_id required | string <uuid> (Repository Id) |
| status | string (Status) Default: "ok" |
| archived_knowledge_bases | integer (Archived Knowledge Bases) Default: 0 |
Response samples
- 200
- 422
{- "archived_knowledge_bases": 2,
- "repository_id": "00000000-0000-0000-0000-000000000001",
- "status": "ok"
}List knowledge bases in repository
List a repository's enabled knowledge bases.
Returns only knowledge bases whose status is enabled — draft, disabled and
archived ones are excluded. (The account-wide GET /knowledge-bases listing
is broader: it excludes only archived.)
Required privileges: KNOWLEDGE_HUB_KB_LIST.
Authorizations:
path Parameters
| repository_id required | string <uuid> (Repository Id) UUID of the repository |
query Parameters
| limit | integer (Limit) [ 1 .. 1000 ] Default: 50 Maximum results to return |
| offset | integer (Offset) >= 0 Default: 0 Pagination offset |
Name (string) or Name (null) (Name) Filter by knowledge base name |
Responses
Response Schema: application/json
| total required | integer (Total) Total number of items matching filters |
| limit required | integer (Limit) Limit applied |
| offset required | integer (Offset) Offset applied |
required | Array of objects (Knowledge Bases) |
Response samples
- 200
- 422
{- "knowledge_bases": [
- {
- "collection_name": "hr-policies-kb-1a2b3c4d5e6f",
- "created_at": "2026-01-15T10:30:00Z",
- "default_top_k": 10,
- "description": "HR policies for employee self-service",
- "embedding_model": "cohere.embed-v4:0",
- "field_source_counts": { },
- "id": "10000000-0000-0000-0000-000000000001",
- "kb_schema": {
- "fields": [ ]
}, - "name": "HR Policies KB",
- "repository_id": "00000000-0000-0000-0000-000000000001",
- "retrieval_mode": "hybrid",
- "source_count": 1,
- "status": "enabled",
- "updated_at": "2026-02-01T09:00:00Z"
}
], - "limit": 20,
- "offset": 0,
- "total": 1
}