Index a single object

Indexing individual objects

This endpoint allows you to add a single object to a specific collection in Tallyfy Answers. Use this method when you need to index objects in response to real-time events or user actions in your application.

When to use this endpoint

This endpoint is ideal for:

• Adding individual records as they’re created
• Updating existing objects with new information
• Testing your integration with Tallyfy Answers
• Low-volume indexing operations

For high-volume operations, the import objects endpoint offers significantly better performance.

API endpoint

POST /v1/collections/{collection_name}/objects

Request parameters

Parameter	Type	Required	Description
collection_name	path	Yes	Name of the collection where the object will be indexed

Request body

The request body should contain a JSON object with the data you want to index. For example:

{
  "id": "product-123",
  "name": "Wireless Headphones",
  "description": "Premium noise-canceling headphones with 20-hour battery life",
  "price": 79.99,
  "categories": ["electronics", "audio", "wireless"]
}

Response

A successful request returns a 201 Created status code and a JSON response containing:

{
  "id": "product-123",
  "status": "success"
}

Error scenarios

Status	Description
400	Malformed request or invalid object format
404	Collection not found
409	Object ID conflict (when using custom IDs)
413	Object size too large

Example request

curl -X POST https://go.tallyfy.com/api/collections/products/objects \
  -H "X-Answers-API-Key: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "product-123",
    "name": "Wireless Headphones",
    "price": 79.99,
    "categories": ["electronics", "audio"]
  }'

Performance considerations

For indexing multiple objects, consider using the bulk import endpoint instead of making multiple individual requests. The bulk endpoint is optimized for higher throughput and will significantly reduce API request overhead.

Related articles

Objects > Index multiple objects

The batch import endpoint allows efficient indexing of multiple objects into Tallyfy Answers collections through a single API call using JSON array format with background processing for large datasets and comprehensive error handling.

Collections > Create a collection

Creating collections in Tallyfy Answers requires using a POST API endpoint with a unique collection name and optional description where the system automatically detects data types as objects are indexed.

Objects > Get an object

The Tallyfy Answers API provides a GET endpoint that retrieves individual objects from collections using their unique identifier and returns complete object data with all properties including system-generated timestamps.

Objects > Delete an object

The DELETE endpoint permanently removes specific objects from Tallyfy Answers collections using unique identifiers with no recovery option and returns confirmation upon successful deletion.