Bundles / Create

Create Bundle

Create a new bundle to organize and group related seeds together. Bundles act as folders or collections, allowing you to scope searches to specific document sets. Seeds can belong to multiple bundles simultaneously.

POST {baseAPIUrl}/bundles

Authentication

Required. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Query Parameters

ParameterTypeRequiredDescription
appIdstringRequiredApplication identifier
externalUserIdstringRequiredExternal user identifier

Request Body

FieldTypeRequiredDescription
namestringRequiredBundle name (1-100 characters)
colorstringOptionalHex color code (default: #4A90E2)
iconstringOptionalIcon name (e.g., folder, book)
descriptionstringOptionalBundle description (max 500 chars)
metadataobjectOptionalCustom metadata object

Response

FieldTypeDescription
idstringUnique bundle identifier
namestringBundle name
colorstringHex color code
iconstringIcon character
seedCountnumberNumber of seeds (0 for new)
createdAtstringISO 8601 timestamp

Try It

Query Parameters

Application identifier for multi-tenant isolation

External user identifier for data isolation

Request Body

Bundle name (1-100 characters)

Hex color code (default: #4A90E2)

Icon name (e.g., folder, book)

Bundle description (max 500 characters)

Custom metadata object