Skip to main content

Documentation Index

Fetch the complete documentation index at: https://relevanceai.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
What Are Inputs?

Inputs are the essential data your tool needs to do its job. Think of them as the information your tool asks for before it can perform its magic - whether that information comes from a human user, an AI agent, or another tool.

​
Basic Input Types

​
Text input

A simple single-line text field for short answers like names, IDs, or brief responses

​
Long text input

A multi-line text area perfect for detailed descriptions, paragraphs, or longer content

​
Numeric input

Accepts only numbers, ideal for quantities, ages, or any numerical data

​
Checkbox

A simple yes/no toggle for binary choices (true/false, on/off)

​
Selection Input Types

​
Options dropdown

A menu with predefined choices for users to select from

​
Text list

Allows entering multiple text items, typically one per line

​
Table

Structured data organized in rows and columns, similar to a spreadsheet

​
Advanced Input Types

​
JSON

When you specify a JSON input, you can optionally provide a JSON Schema in the advanced options to describe the format of the JSON input. This schema describes the expected structure of the JSON input, and is used to help guide the agent to provide data in the correct format. Providing a schema helps to improve the accuracy of calling the tool.
The structure outlined in schema.json corresponds the data format used in example.json.
{
  "timestamp": 1948832903,
  "response": {
    "name": "Pierre Vinken",
    "age": 30,
    "bio": "Pierre Vinken, 61 years old, joined the board as a nonexecutive director Nov. 29th"
  },
  "is_prospect": true,
  "status": "inactive"
}
The schema describes the overall structure of the data and the types that each item can be. Use the documentation at json-schema.org for more options.
Note that the only supported keywords are properties - all other schema keywords (e.g. additionalProperties, examples, etc.) will be ignored.

​
List of JSONs

Handles multiple JSON objects in a list structure

​
Knowledge table

For inputting or selecting from predefined knowledge bases

​
File Handling

​
File to text

Uploads a file and converts its contents to text

​
File to URL

Uploads a file and provides a URL to access it

​
Multiple files to URLs

Same as above but for multiple files at once

​
Authentication Types

​
API key

Securely input API keys for external services

​
OAuth account

Handles secure connection to third-party services with proper authorization. OAuth account inputs allow users to connect their accounts from third-party services (like HubSpot, Slack, Google Sheets, etc.) to your tool. OAuth account inputs can be used in tools that support OAuth authentication, or in Python code steps. For details on using OAuth accounts in Python code, see the Python Tool step documentation.

​
Creating an Input

To add an input to your tool:
  1. Select the appropriate input type from the options
  2. Give your input a descriptive name
  3. Add a helpful description so users know what to enter
  4. Assign a variable name (this is how your tool will reference this input)

​
Using Default Values as Constants

Default values are pre-filled inputs that make your tools more efficient and easier to use.

​
Why Use Default Values?

  • Create constants - Set values that stay the same across multiple runs (API endpoints, base URLs)
  • Provide examples - Show realistic sample data to demonstrate how the tool works
  • Save time - Pre-fill common inputs to reduce repetitive typing and potential errors

​
How to Set Default Values

  1. Find the input field you want to set a default for
  2. Enter your desired default value
  3. Click “Set value as default”
Once set, these values will automatically appear whenever the tool runs, unless specifically changed by the user.