Objects > Index a single object
Index multiple objects
This endpoint allows you to efficiently index multiple objects into Tallyfy Answers in a single API call. It significantly outperforms making multiple individual object creation requests, especially for large datasets or initial data loading.
Large batch imports are processed in the background, allowing you to monitor progress and cancel operations if needed using the Tasks endpoints.
POST /collections/{collection_name}/batch
Parameter | Type | Required | Description |
---|---|---|---|
collection_name | path | Yes | Name of the collection to import objects into |
The request body must be a JSON array containing multiple document objects. Each object should include the required fields for your collection schema.
Example JSON array format for three objects:
[ { "uid": "article-123", "title": "Getting Started Guide", "content": "Complete guide to getting started...", "url": "https://example.com/guide", "source": "Documentation", "snippet": "Quick start guide for new users" }, { "uid": "article-456", "title": "Advanced Features", "content": "Advanced functionality overview...", "url": "https://example.com/advanced", "source": "Documentation", "snippet": "Deep dive into advanced capabilities" }]
Set the Content-Type
header to:
application/json
A successful request returns a 200 OK
status code and a summary of the import operation:
{ "success": true, "count": 3, "errors": []}
If some objects fail to import while others succeed, you’ll receive a 207 Multi-Status
response:
{ "success": true, "count": 2, "errors": [ { "line": 2, "error": "Invalid object format at line 2", "object": "{malformed json}" } ]}
Status | Description |
---|---|
400 | Invalid JSONLines format or request body |
404 | Collection not found |
413 | Request body too large |
curl -X POST "https://answers.tallyfy.com/collections/docs/batch" \ -H "Authorization: Bearer your_api_key" \ -H "Content-Type: application/json" \ -d '[ { "uid": "guide-123", "title": "Getting Started", "content": "Complete guide to getting started with our platform...", "url": "https://example.com/guide", "source": "Documentation", "snippet": "Quick start guide for new users" } ]'
- Size limitations: Keep individual requests under 5MB
- Chunking: For large datasets, break imports into smaller batches of 100-1000 objects
- ID handling: You can mix objects with and without custom IDs in the same import
- Error handling: Process the errors array in the response to identify and fix failed objects
- Parallel imports: For very large datasets, you can make multiple parallel import requests to different collections
- Initial data population
- Regular data synchronization from external systems
- Bulk updates to multiple objects
- Periodic content refreshes
Collections > Create a collection
- 2025 Tallyfy, Inc.
- Privacy Policy
- Terms of Use
- Report Issue
- Trademarks