Hyperspell icon

Hyperspell

Add documents to Hyperspell and run semantic search or grounded generation from any workflow

Actions10

Document → Add

AI-generated

Summary

Add and index a document in Hyperspell by sending its text, with an optional title, resource ID, date, and metadata. A supplied resource ID is used for upsert: an existing document with that ID is updated; otherwise, Hyperspell generates a new ID.

Inputs

  • Text (required) — Full text of the document to index.
  • Title — Optional document title.
  • Resource ID — Stable ID for upsert; an existing document with this ID is updated, and if omitted a new ID is generated.
  • Date — Document creation or last-update date, used by ranking and date-range filters.
  • Metadata (JSON) — Optional JSON object of custom metadata for filtering. Keys must be alphanumeric or underscores and no more than 64 characters; values must be strings, numbers, booleans, or null.
  • Act as User — User ID to run the request as, such as the connected account's Clerk ID or email. Overrides the credential's value; if left empty, the node uses the credential value or defaults to the app's user with the most documents. If no users exist, the request runs app-scoped.

Output shape

A single response item from the Hyperspell add endpoint.

The operation sends a POST request to /memories/add. The source does not transform the successful response, so its fields depend on the API response. Invalid metadata JSON or a non-object metadata value raises an error; API errors are also raised.

Links

Discussion