Index a single object

Indexing individual objects

This endpoint lets you 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 much 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 you’ll index the object

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[^1] 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 you’ll greatly reduce API request overhead¹.

Related articles

Objects > Index multiple objects

The batch import endpoint lets you index multiple objects into Tallyfy Answers collections…

Collections > Create a collection

Create collections in Tallyfy Answers using a POST request to the /v1/collections endpoint. Each…

Objects > Get an object

Retrieve a specific object from a Tallyfy Answers collection using its unique identifier…

Answers > Objects

Objects are JSON data records in Tallyfy Answers that belong to collections. They can be…

Footnotes

1. Network latency and processing time per request, typically milliseconds to seconds ↩

Was this helpful?

YesNo