Guides
CLI
Access Orthogonal APIs from the command line
The Orthogonal CLI (orth) lets you search, explore, and run tools and APIs from your terminal, and check your account and credits.
Connect your agent
Takes about two minutes. Set up the skill where your agent runs. Works with Node.js 18+.
- Open the terminal Codex uses.
- Set up the skill using the URL below.
- Start a new chat and ask Codex to use the Orthogonal skill.
Once the skill is set up, ask your agent to use Orthogonal.
Installation
After installation, the CLI is available as orth. orth login signs you in (see Authentication).
Authentication
Sign in from the browser:
Once you approve, orth login saves a new API key for your own account. orth whoami shows who you are signed in as, and orth logout removes the saved key.
To use a key you created, such as an organization key, save it:
Without a browser (CI, a server), set the key as an environment variable instead. It takes precedence over the saved one:
Get your API key from the dashboard.
Commands
Search APIs
Find APIs by keyword:
Output:
List All APIs
View API Endpoints
See all endpoints for an API:
Output:
View Endpoint Details
Get full parameter details for an endpoint:
Output:
Call an API
Execute an API endpoint:
| Flag | Description |
|---|---|
-q, --query <key=value...> | Query parameters |
-b, --body <json> | The JSON request body (-d, --data is the same). A body piped in is read too. |
-X, --method <method> | The HTTP method, for a path that has several (default GET) |
--dry-run | Price the call and check your balance without running it |
-o, --output <file> | Save the response to a file, such as an image |
--raw | Print only the response JSON; the cost goes to stderr |
Get integration code
Print code that calls an endpoint from your app:
Examples
Find someone’s email
Scrape a webpage
Search the web
Verify an email
Account and credits
| Command | What it shows |
|---|---|
orth whoami | Who the key belongs to, you or an organization, and where the key comes from |
orth balance | The credit balance of whoever the key bills, and where to add credits |
orth usage | Recent paid calls and the total spent. -d, --days sets how far back to look (default 30), -l, --limit how many calls to list (default 20), and --offset how many of the newest to skip. |
A personal key bills your account; an organization key bills the organization’s shared credits, so orth balance shows those. Add --json to any of these for output a script or agent can read. Credits are added in the browser, at Add funds.
For API providers
Listing an API and payouts happen outside the CLI. List your API in Your listings or with your own agent over MCP, and follow its earnings at Earnings and payouts. List your API walks through every step.
Options
| Flag | Description |
|---|---|
--help | Show help |
--version | Show version |
Testing without charges
Create a Test key in Account → Keys and use the same API paths and request shape with that key. The prefix selects test mode; no second host or environment flag is needed. Responses use the stored OpenAPI example or JSON response schema. An endpoint without a usable stored response fixture returns 501 and never falls back to a paid call.
Test calls are marked in Logs and share a limit of 60 calls per minute per key. Test keys can read account and catalog data, but cannot publish APIs or change account settings.
On /v1/run, send Orthogonal-Simulate: 503 to test failure handling. Supported simulated statuses are 400, 402, 429, 500 and 503; they do not reach the provider or charge credits.
Environment Variables
| Variable | Description |
|---|---|
ORTHOGONAL_API_KEY | Your Orthogonal API key |
ORTH_API_URL | The API the CLI calls. Defaults to https://www.orthogonal.com/v1. |
ORTH_WEB_URL | The site orth login opens. Defaults to the site that serves ORTH_API_URL. |