Reference
The reference has the exact names, types and defaults of Steel's endpoints, SDKs, commands, signals, errors and tools. For the HTTP API, start with the API conventions, or download the OpenAPI spec. Session configuration has every option that a new session takes, with its default.
API
- ConventionsLearn the rules that every Steel API request follows, from the base URL and authentication to errors, pagination and rate limits.
- SessionsCreate, list, get and release sessions with the Steel API, and work with their logs, recordings, metadata, commands, CAPTCHAs and files.
- Quick actionsScrape a page, capture a screenshot or create a PDF with the Steel API, in one request and with no session to manage.
- ProfilesCreate, list, get and update the browser profiles that new sessions start from, with the Steel API.
- CredentialsStore, list, update and delete the logins that a session fills into sign-in forms, with the Steel API.
- FilesUpload, list, download and delete your organization's global files, which you can copy into any session, with the Steel API.
- ExtensionsUpload, list, download, update and delete the Chrome extensions that your sessions install, with the Steel API.
- ProjectsList your organization's projects and get one of them by its ID, with the Steel API.
- API keysCreate a project key through the Steel API with an organization key, so that each app or environment gets its own key.
SDKs
- TypeScriptInstall the Steel TypeScript SDK, configure the client, and handle errors, retries, and pagination.
- PythonInstall the Steel Python SDK, configure the client, and handle errors, retries, and pagination.
- GoInstall the Steel Go SDK, configure the client, and handle errors, retries, and pagination.
- RustInstall the Steel Rust SDK, configure the client, and handle errors, retries, and pagination.
- CLI commandsLook up every command of the Steel CLI, with its flags and output.
- MCP toolsLook up every tool that the Steel MCP server offers, with its parameters and what it returns.
- CommandsLook up every command that the Commands API accepts, from navigate and snapshot to click, fill, and wait, with its fields and results.
- Proxy locationsEvery country, US state and city that useProxy.geolocation accepts, to run a session through a Steel proxy in that place.
- SignalsLook up every signal that Steel can put on a session, with what triggers it and what to do next.
- ErrorsFix a failed Steel API request. Each error code has its HTTP status, its exact message and the fix.
- GlossaryLook up the terms that the Steel docs use. Each one has a short definition and a link to the page that explains it.