Needle

Learn how to use Needle with Composio

Overview

SLUG: NEEDLE

Description

Needle provides retrieval-augmented generation (RAG) tools that enable semantic search across your data, facilitating the development of AI agents and applications.

Authentication Details

generic_api_key
stringRequired

Connecting to Needle

Create an auth config

Use the dashboard to create an auth config for the Needle toolkit. This allows you to connect multiple Needle accounts to Composio for agents to use.

1

Select App

Navigate to Needle.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Needle Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4needle_auth_config_id = "ac_YOUR_NEEDLE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Needle for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, needle_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Needle toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["NEEDLE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Collection

Description

Tool to create a new collection. use after confirming the collection name.

Action Parameters

description
string
metadata
object
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete files from a collection

Description

Tool to delete files from a specific collection by providing file ids. use after confirming valid file ids to remove from the collection.

Action Parameters

collection_id
stringRequired
file_ids
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get collection stats

Description

Tool to retrieve statistics for a specific collection by its id. use when you need document count, index size, and timestamps after confirming the collection exists.

Action Parameters

collection_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Collection Files

Description

Tool to list all files within a specific collection by its id. use when you have a collection id and need to retrieve its files. supports pagination.

Action Parameters

collection_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Collections

Description

Tool to list collections. use after authenticating with your api key to page through collections.

Action Parameters

limit
integer
offset
integer

Action Response

data
arrayRequired
error
string
pagination
objectRequired
successful
booleanRequired