Requests

Mon, 01 Jan 0001 00:00:00 +0000

Restish supports two request styles: generic HTTP requests for immediate access and API-aware commands generated from an API description for repeated work.

Start With A Generic Request

Browser preview

Edit the command and run it from your browser against the live docs API.

Ready

restish api.rest.sh/get

Enable JavaScript to run this example in the browser.

API Setup and Discovery

Mon, 01 Jan 0001 00:00:00 +0000

Restish can call any URL, but registering an API gives you generated commands, profiles, auth setup, spec caching, and completion.

Configure By Discovery

restish api connect example api.rest.sh 'prompt.api_key: docs-key'
restish example --help

Restish looks for an OpenAPI description through well-known locations and link relations, then caches the spec.

Discovery is intentionally conservative. Restish trusts same-origin spec links by default; use --allow-cross-origin-spec only when you expect the API to advertise its OpenAPI document from another host and you trust that host. Cross-origin discovery still rejects private, loopback, link-local, multicast, and unspecified follow targets unless the original API is already private or local. Use --spec when you need to name a private spec URL directly.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Auth belongs with the request context. In Restish that usually means a profile, so tokens, API keys, and environment-specific credentials do not get copied into every command.

Safe Auth Fixtures

The example API has endpoints that require auth and return only a safe summary. They are useful for learning and testing.

Bearer Token

Browser preview

Edit the command and run it from your browser against the live docs API.

Ready

restish -H 'Authorization: Bearer docs-token' api.rest.sh/auth/bearer --rsh-print b

Guides on Restish

Requests

Start With A Generic Request