Skip to main content
Needle logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 16
  • Triggers: 0
  • Slug: NEEDLE
  • Version: 20261101_00

Tools

Slug: NEEDLE_ADD_FILES_TO_COLLECTIONTool to add files to a collection by providing file URLs. Use when you need to add one or more files to an existing collection. URLs can be public or private (generated via the Files API).

Input Parameters

array
required
List of files to add to the collection. Each file must have a name and URL.
string
required
The unique identifier of the collection to add files to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_ADD_FILES_TO_LOCAL_CONNECTORTool to add files to a local connector by providing file metadata. Use when you need to add external files to a connector using their URLs.

Input Parameters

array
required
List of files to add to the local connector
string
required
The unique identifier of the local connector to add files to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_CREATE_COLLECTIONTool to create a new collection. Use after confirming the collection name.

Input Parameters

string
required
Name of the collection. Must be unique within your account.
object
Optional arbitrary JSON metadata associated with the collection.
string
Optional human-readable description of the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_CREATE_LOCAL_CONNECTORTool to create a local connector that monitors specified folders on a device. Use when setting up file indexing from a local machine into Needle collections.

Input Parameters

string
required
Operating system of the device (e.g., macOS, Windows, Linux)
string
required
CPU model/architecture of the device
string
required
Name for the local connector. Should be descriptive of the device or purpose.
array
required
List of folders to monitor for file indexing
string
required
Name of the device running the connector
string
required
Model identifier of the device
string
required
Serial number or unique identifier for the device
array
required
List of collection IDs to associate with this local connector. Files from the monitored folders will be indexed into these collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_DELETE_FILES_FROM_COLLECTIONTool to delete files from a specific collection by providing file IDs. Use after confirming valid file IDs to remove from the collection.

Input Parameters

array
required
List of file IDs to delete from the collection
string
required
The unique identifier of the collection from which to delete files

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_DELETE_FILES_FROM_LOCAL_CONNECTORTool to delete files from a local connector by filename or file IDs. Use when you need to remove files from a connector’s local storage.

Input Parameters

string ("name" | "file_ids")
required
Method to identify files for deletion: ‘name’ to delete by filename, ‘file_ids’ to delete by file IDs
string
Name of the file to delete. Required when ‘by’ is ‘name’
array
List of file IDs to delete. Required when ‘by’ is ‘file_ids’
string
required
The unique identifier of the connector from which to delete files

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_GET_COLLECTIONTool to retrieve details for a specific collection by its ID. Use when you need to get collection metadata including name, creation date, and search query count.

Input Parameters

string
required
The unique identifier of the collection to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_GET_COLLECTION_STATSRetrieve statistics for a collection by ID, including user, chunk and character counts and file counts and bytes grouped by status.

Input Parameters

string
required
The unique identifier of the collection. Verify the exact ID when collections have similar names to avoid retrieving stats for the wrong collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_GET_FILE_DOWNLOAD_URLTool to get a short-lived signed private download URL for a Needle file. Use when you need to retrieve file content but the public storage URL requires authentication. The returned URL should be used immediately as it expires quickly.

Input Parameters

string
required
The unique identifier of the file to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_GET_FILE_UPLOAD_URLTool to get signed URLs for uploading local files to Needle. Use when you need to upload files to a collection. The upload URLs are valid for a short time, so upload files immediately after receiving the URLs. Multiple content types can be specified to generate multiple upload URLs in a single request.

Input Parameters

array
required
MIME types for files to upload (e.g., application/pdf, text/plain, image/jpeg). Multiple content types can be provided to generate multiple upload URLs at once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_GET_LOCAL_CONNECTORTool to retrieve details of a local connector by its ID. Use when you need information about a specific local connector’s configuration, device details, and associated folders.

Input Parameters

string
required
The unique identifier of the local connector.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_LIST_COLLECTION_FILESList file metadata for a collection by ID, with pagination parameters. File URLs may be included; the returned total is the number of files in the current response, not necessarily the collection-wide count.

Input Parameters

integer
Number of files to return per page, must be >=1
integer
Number of items to skip for pagination, must be >=0
string
required
Unique identifier of the collection Multiple collections can share similar names; verify the correct collection_id before operating on returned files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_LIST_COLLECTIONSTool to list collections. Use after authenticating with your API key to page through collections. Similar collection names can exist; always verify the correct collection_id from results before performing subsequent operations.

Input Parameters

integer
Maximum number of collections to return (if supported by API)
integer
Number of collections to skip before collecting results (if supported by API)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_LIST_CONNECTORSTool to list connectors. Use to retrieve all configured connectors in your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_LIST_LOCAL_CONNECTORSTool to list local connectors. Use to retrieve all local connectors configured in your Needle account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NEEDLE_SEARCH_COLLECTIONTool to perform semantic search within a specific Needle collection and return ranked results with source references. Use when you need to retrieve relevant content from a known collection using natural language queries.

Input Parameters

string
required
The natural-language search query to find relevant content in the collection.
integer
Maximum number of search results to return. Default is 10 (maximum).
integer
Offset for pagination to skip a number of results.
object
Optional pass-through object for additional retrieval parameters supported by the API (e.g., filters, future knobs).
string
Maximum similarity distance threshold for results, between 0 and 1. Lower values mean stricter relevance. Example: ‘0.65’.
string
required
The unique identifier of the collection to search in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not