Add a memory
WriteAdds an arbitrary document to the index.
Permissions and limits
Account permissions
- A Hyperspell API key or user token
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add, query and manage Hyperspell memories, connections, vaults and entities, with retrieval only (no generated answers).
Explore 42 workflow actions for Hyperspell, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Adds an arbitrary document to the index.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add an emoji reaction to a message on a connected integration.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Adds multiple documents to the index in a single request.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Approve a pending-review resource for indexing.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Apply multiple folder-policy changes as one operation.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Recursively crawl a website to make it available for indexed search.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create or update a folder policy for a specific connection.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a folder policy for a specific connection.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete emotional state for the authenticated user.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a memory accessible to the authenticated credential.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Fetch one resource live by id.
Endpoint to get basic user data.
Check whether a URL has been crawled and its current indexing status.
Fetch a single entity belonging to the current app.
Retrieve the most recent emotional state for the authenticated user.
Retrieve an indexed document.
Retrieve the result of a previous query.
Return up to limit most recent emotional states, newest first.
Ingest real-time messages for immediate full-text search.
A repeated request may repeat the external action. Review the previous result before retrying a write.
List all integrations for the user.
List available channels/chats for a connected integration.
List all connections for the user.
List entities available to the current app.
List all folder policies for a specific connection.
List one level of folders from the user's connected source.
List the user's connected sources and the live capabilities each supports.
This endpoint allows you to paginate through all documents in the index.
Paginate through all prior queries for the app, newest first.
Page through a source's resources live (no indexing side effect).
List the app's users , distinct document owners with document counts.
This endpoint lists all collections, and how many documents are in each collection.
Retrieves documents matching the query.
Reject a pending-review resource.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Revoke Hyperspell's access to a provider and delete this user's stored data.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Score an individual highlight.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Score the result of a query.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Search a source live for content that may not be indexed yet.
Search the current app's entities by meaning.
Send a message to a channel or conversation on a connected integration.
A repeated request may repeat the external action. Review the previous result before retrying a write.
This endpoint shows the indexing progress of documents, both by provider and total.
Updates an existing document in the index.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Save per-user options on a connection owned by the authenticated user.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in Hyperspell. A saved workflow is not a completed provider action.