Skip to content

Authentication

How does authentication work with Tallyfy Answers API?

All API requests to Tallyfy Answers require authentication using an API key.

This API key validates your identity and permissions when accessing Tallyfy Answers endpoints.

Tallyfy uses a centralized identity and access management system at account.tallyfy.com for all products.

This system handles sign up, sign in, SSO, and account management functions like password recovery across all Tallyfy products.

If your account is a member of multiple organizations, you can easily switch between them.

Click your name/profile picture in the top-right corner and select “Switch organization” to access other roles and organizations associated with your account.

What API key header is required?

Add the following header to all your Tallyfy Answers API requests:

X-Answers-API-Key: your_api_key

Replace your_api_key with the actual API key provided to your Tallyfy account.

How do you obtain a Tallyfy Answers API key?

To get a Tallyfy Answers API key:

  1. Log in to your Tallyfy Answers account
  2. Navigate to the API Settings section
  3. Click Generate API Key
  4. Copy the generated key for use in your applications

What are API key security best practices?

  • Do not share your Tallyfy API key in public repositories or client-side code
  • Store your API key in environment variables or secure configuration files
  • Regenerate your API key if you suspect it has been compromised
  • Use different API keys for development and production environments

What does an authenticated request look like?

Terminal window
curl -X GET https://go.tallyfy.com/api/answers/collections/my_collection \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

How do you troubleshoot authentication errors?

If you receive a 401 Unauthorized response, check that:

  • Your Tallyfy Answers API key is valid and active
  • You’ve correctly included the X-Answers-API-Key header
  • Your account has the necessary permissions for the requested operation

Objects > Get an object

You can retrieve individual objects from Tallyfy Answers using a GET request to the API endpoint with the collection name and object ID which returns the complete object data with all properties including system fields like creation and update timestamps.

Answers > Search

Tallyfy Answers enables users to find specific objects within collections through natural language queries or specific search terms by performing query operations against designated collections.

Collections > Delete a collection

The DELETE endpoint permanently removes collections and their objects through a straightforward API call while offering best practices and alternatives to mitigate risks of irreversible data loss.

Answers > Objects

Objects in Tallyfy Answers are fundamental JSON-formatted data records that belong to collections and can be indexed retrieved and searched with flexible schemas that automatically detect properties and support both custom and auto-generated unique identifiers.