Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

API Key → Create

AI-generated

Overview

This node interacts with the Typesense search platform, specifically allowing the creation of API keys with defined permissions. It is useful for managing access control by generating API keys that specify allowed actions and accessible collections. For example, a user can create an API key that permits searching and creating documents within certain collections.

Use Case Examples

  1. Create an API key with permissions to search and create documents in specified collections.
  2. Generate an API key that allows managing collections and updating documents.

Properties

Name Meaning
Description Description for the API key, used to identify or explain the purpose of the key.
Actions Actions the API key is allowed to perform, such as searching, creating, updating, or deleting documents, and managing collections.
Collections Comma-separated list of collection names the API key can access. If left empty, the API key can access all collections.

Output

JSON

  • apiKey - The created API key details, including permissions and description.

Dependencies

  • Requires an API key credential for Typesense to authenticate requests.

Troubleshooting

  • Ensure the 'Description' field is provided as it is required; missing it will cause an error.
  • Verify that the 'Actions' selected are valid and supported by the Typesense API.
  • If specifying collections, ensure the collection names are correct and exist in the Typesense instance.
  • Common errors may include authentication failures if the Typesense API key credential is invalid or missing.
  • Network or API errors from the Typesense service should be checked and retried if transient.

Links

Discussion