← Tools Reference

Needle

Needle integration (AI, Data). Imported from open-connector.

API key7 toolshttps://search.needle.app
GET
needle_list_collections
List the Needle collections that the API key can access.

/api/v1/collections

POST
needle_create_collection
Create a Needle collection and optionally attach existing Needle file IDs.

/api/v1/collections

2 parameters
ParamTypeRequiredDescription
namestringrequiredThe name of the collection to create.
file_idsarrayoptionalExisting Needle file IDs to attach when the collection is created.
GET
needle_get_collection
Get the details of a single Needle collection.

/api/v1/collections/{collection_id}

1 parameter
ParamTypeRequiredDescription
collection_idstringrequiredThe Needle collection ID.
GET
needle_get_collection_stats
Get indexing and storage statistics for a Needle collection.

/api/v1/collections/{collection_id}/stats

1 parameter
ParamTypeRequiredDescription
collection_idstringrequiredThe Needle collection ID.
GET
needle_list_collection_files
List the files currently attached to a Needle collection.

/api/v1/collections/{collection_id}/files

1 parameter
ParamTypeRequiredDescription
collection_idstringrequiredThe Needle collection ID.
POST
needle_add_files_to_collection
Import one or more URL-backed files into a Needle collection for indexing.

/api/v1/collections/{collection_id}/files

2 parameters
ParamTypeRequiredDescription
collection_idstringrequiredThe Needle collection ID.
filesarrayrequiredThe URL-backed files that Needle should import.
POST
needle_search_collection
Search a Needle collection for the most relevant retrieved content.

/api/v1/collections/{collectionId}/search

5 parameters
ParamTypeRequiredDescription
collection_idstringrequiredThe Needle collection ID.
textstringrequiredThe search query text.
top_kintegeroptionalThe maximum number of results to return.
offsetintegeroptionalThe zero-based result offset.
collectionIdstringrequiredPath parameter: collectionId