Core concepts
A shared vocabulary for finding tools, granting access and understanding a request.
Tools and platforms
A tool is one action with an exact ID and a defined set of inputs. A platform is the service or subject that action works with. Several tools can belong to the same platform.
Search and list are actions. A tool that searches X belongs with X; a tool that lists Pinterest boards belongs with Pinterest.
Providers
A provider supplies the capability behind a tool. Some tools offer a choice of providers, each with its own inputs, coverage and pricing.
By default Relvo routes each call automatically and charges the recorded cost of the provider it used. To pin a provider, send its id as provider in both the quote and the execution; a pinned call never falls back to another provider. The provider directory helps you explore the suppliers.
Teams and projects
A team brings people together with one plan and balance. Projects keep related credentials, access and work within a chosen context. A person’s team role and project roles determine what they can see or run. See Teams & projects.
An API key belongs to its project context. Changing the project in the app changes the context you are managing.
Quotes and charges
Every call is quoted before it runs. A free quote returns the most the call can cost (maximumChargeMicros) and the price version it used. Running it reserves that amount from your team’s prepaid balance; when it ends, Relvo charges the actual cost once and returns the rest.
Prices are integer micros of USD: 1,000,000 micros is USD 1.
Executions and results
An execution records an attempt to run a tool. It has an identifier and progress, followed by a result or an error. The result can contain structured data, text or links to generated files.
Keep the execution ID when you need to follow progress, inspect a failure or ask for help.
Connected apps
Project administrators connect accounts for the selected project on Connections ↗. Each app adds tools named <app>__<operation> to your project’s catalog, for example github__issues_create. They take a connectionId, or auto to select an available connection in that project.
Agents never receive the stored credentials: Relvo adds them to each request and hides secrets in responses. Project administrators can restrict connection methods and paths for everyone, make a connection read-only, or require approval before changes. These rules apply to every project member; an API key can be limited further.