16 available actions
What your AI agent can do in Needle
Needle provides retrieval-augmented generation (RAG) tools that enable semantic search across your data, facilitating the development of AI agents and applications. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 16 actions.
Common starting points
- Search CollectionTool to perform semantic search within a specific Needle collection and return ranked results with source references.
- Get CollectionTool to retrieve details for a specific collection by its ID.
- Create CollectionTool to create a new collection.
- Create Local ConnectorTool to create a local connector that monitors specified folders on a device.
- Delete files from a collectionTool to delete files from a specific collection by providing file IDs.
- Delete files from local connectorTool to delete files from a local connector by filename or file IDs.
Browse all 16 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 10 actions
- Get CollectionTool to retrieve details for a specific collection by its ID.
- Get collection statsTool to retrieve statistics for a specific collection by its ID.
- Get File Download URLTool to get a short-lived signed private download URL for a Needle file.
- Get File Upload URLTool to get signed URLs for uploading local files to Needle.
- Get local connectorTool to retrieve details of a local connector by its ID.
- List Collection FilesTool to list all files within a specific collection by its ID.
- List CollectionsTool to list collections.
- List ConnectorsTool to list connectors.
- List Local ConnectorsTool to list local connectors.
- Search CollectionTool to perform semantic search within a specific Needle collection and return ranked results with source references.
Create & communicateCreate records or send supported messagesView 4 actions
- Add files to a collectionTool to add files to a collection by providing file URLs.
- Add Files to Local ConnectorTool to add files to a local connector by providing file metadata.
- Create CollectionTool to create a new collection.
- Create Local ConnectorTool to create a local connector that monitors specified folders on a device.
Remove & cancelRemove records or cancel supported workView 2 actions
- Delete files from a collectionTool to delete files from a specific collection by providing file IDs.
- Delete files from local connectorTool to delete files from a local connector by filename or file IDs.
Connection record
A connection you can control.
- Sign-in
- Customer-managed key
- Setup
- Use a key you create and control. It is stored securely and limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Needle
How does the agent connect to Needle?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Needle?
The page above lists the 16 actions currently available through the Needle connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Needle included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Needle is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Needle to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.