Remote retrieval

Learn how to use Remote retrieval with Composio

Overview

SLUG: REMOTE_RETRIEVAL

Description

Remote Retrieval automates the logistics of managing equipment returns, providing efficient tracking and management of laptop and monitor returns.

Authentication Details

generic_api_key
stringRequired

Connecting to Remote retrieval

Create an auth config

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

1

Select App

Navigate to [Remote retrieval](https://platform.composio.dev?next_page=/marketplace/Remote retrieval).

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 Remote retrieval 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
4remote_retrieval_auth_config_id = "ac_YOUR_REMOTE_RETRIEVAL_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 Remote retrieval 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, remote_retrieval_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 [Remote retrieval toolkit’s playground](https://app.composio.dev/app/Remote retrieval)

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=["REMOTE_RETRIEVAL"])
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: Get All Orders

Description

Tool to retrieve a paginated list of all orders. use when you need to list orders with optional filters like status or dates. call after authentication.

Action Parameters

from_date
page
integer
per_page
integer
status
string
to_date

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Company Details

Description

Tool to retrieve detailed information for a company. use after confirming a valid company id.

Action Parameters

company_id
stringRequired
expand_contacts
boolean
include_financials
boolean
industry_filter
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: RemoteRetrieval: Validate User

Description

Tool to validate the provided api key. use when you need to confirm the api key's validity.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired