Skip to content
Tallyfy

Create a collection

How do you create collections in Tallyfy Answers?

Section titled “How do you create collections in Tallyfy Answers?”

Before adding objects to Tallyfy Answers, you’ll need to create a collection.

Each collection requires a unique name, and Tallyfy Answers automatically detects the data types of your objects as you index them.

API endpoint

Section titled “API endpoint”
POST /v1/collections

Request body

Section titled “Request body”

Your request body should contain a JSON object with these collection properties:

ParameterTypeRequiredDescription
namestringYesUnique name for the collection (can include letters, numbers, hyphens, and _)
descriptionstringNoOptional description explaining the collection’s purpose

Example request body:

{
  "name": "products",
  "description": "Collection of product information including names, descriptions, and pricing"
}

Response

Section titled “Response”

A successful request returns a 201 Created[^1] status code and a JSON response containing:

{
  "name": "products",
  "description": "Collection of product information including names, descriptions, and pricing",
  "created_at": "2023-08-15T14:32:21Z"
}

Error scenarios

Section titled “Error scenarios”
StatusDescription
400Invalid request format or collection name
409Collection name already exists

Example request

Section titled “Example request”
Terminal window
curl -X POST https://go.tallyfy.com/api/collections \
  -H "X-Answers-API-Key: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "products",
    "description": "Collection of product information"
  }'

What data types does Tallyfy Answers support?

Section titled “What data types does Tallyfy Answers support?”

Tallyfy Answers automatically detects these data types when you index objects:

Data TypeExampleDescription
string”Wireless Headphones”Text values that can be searched and filtered
list of strings[“electronics”, “audio”]Arrays of text values for multi-value fields

What are collection naming best practices?

Section titled “What are collection naming best practices?”
  • Use lowercase letters, numbers, hyphens, and _
  • Choose descriptive names that reflect the content (e.g., “products”, “users”, “articles”)
  • Don’t use spaces or special characters
  • Keep collection names concise but meaningful
  • Use consistent naming conventions across all collections
Section titled “Related articles”

Answers > Collections

Collections in Tallyfy Answers group similar objects together, like database tables. They…
Get in touch
About Tallyfy