Aitable Unofficial icon

Aitable Unofficial

Interact with Aitable.ai API (Unofficial Integration)

Actions5

Overview

This node enables searching for records within a specific datasheet in Aitable.ai, an unofficial integration with the Aitable API. It supports both simple text search across record fields and advanced filtering using Aitable's formula syntax. Users can specify which columns to search and limit the number of results returned.

Common scenarios include:

  • Quickly finding project details or entries matching a keyword.
  • Filtering records based on complex criteria (e.g., status, dates) using formulas.
  • Retrieving a subset of records from large datasheets for further processing or automation.

Practical example:

  • Searching for all records where the "Name" field contains "Project X".
  • Using a formula filter like {Status}="Completed" to get only completed tasks.
  • Limiting results to 50 records to avoid overwhelming downstream nodes.

Properties

Name Meaning
Space ID The unique identifier of the space containing the datasheet (e.g., spcX9P2xUcKst).
Datasheet ID The unique identifier of the datasheet to search within (e.g., dstXXXXXXXXXXX).
Simple Search A plain text term to search for within the records' fields. Leave empty to retrieve all records.
Filter By Formula An advanced filter using Aitable formula syntax for precise querying (e.g., {Name}="Project X").
Columns to Search Comma-separated list of column IDs to restrict the search to specific columns. Leave empty to search all.
Maximum Results The maximum number of records to return, between 1 and 1000. Defaults to 100.

Output

The output is an array of JSON objects, each representing a record found in the datasheet. Each record object includes:

  • All fields of the record as key-value pairs under fields.
  • Metadata such as record ID and other record-specific information.
  • The datasheetId property indicating the source datasheet.

Example output structure (simplified):

{
  "id": "recXXXXXXXXXXX",
  "fields": {
    "Name": "Project X",
    "Status": "Completed",
    "Description": "Details about Project X"
  },
  "datasheetId": "dstXXXXXXXXXXX"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Aitable.ai API via an API key credential configured in n8n.
  • The node uses HTTP requests authenticated against the Aitable API endpoint at https://aitable.ai.
  • Proper permissions on the specified space and datasheet are necessary to perform searches.

Troubleshooting

  • Missing Datasheet ID: The node requires a valid Datasheet ID; ensure it is provided and correctly formatted.
  • API Authentication Errors: Verify that the API key credential is correctly set up and has access rights.
  • No Records Found: If no records match the search or filter criteria, the node returns a message indicating no data was found.
  • Formula Syntax Errors: Incorrect formula syntax in the "Filter By Formula" property may cause errors; validate formulas according to Aitable's documentation.
  • Exceeded Maximum Results: Setting "Maximum Results" too high may impact performance; keep it within recommended limits (1-1000).
  • Network Issues: Connectivity problems to the Aitable API will result in errors; check network and firewall settings.

Error messages typically include the reason for failure and sometimes the raw API response for debugging. Use the "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion