Skip to content

API keys API

Set up your agent

Give your coding agent a Steel browser and the Steel skills, so that it browses and writes Steel code the right way. Learn more

Install the Steel CLI. It signs you in and installs the skills for your coding agents.

curl -fsS https://setup.steel.dev | sh

Or send this prompt to your coding agent, and it does the same:

Read https://setup.steel.dev/install.md and follow it to set up Steel for this coding client.
Then continue my requested task using the installed Steel skill.

Set up your agent →

An API key authenticates your requests to Steel. This endpoint creates a project key, which works in one project only. For the base URL and authentication, see API conventions. For the error codes, see Errors.

Endpoints

Create an API key

POST/v1/api-keys

Creates a project key. Authenticate with an organization key, which works across the organization.

A project key cannot create keys, and an organization key cannot create another organization key. The new key does not depend on the key that created it. When you revoke the organization key, the project key keeps working.

Parameters

NameTypeRequiredDescription
projectIdstring (uuid) · bodyYesThe project to bind the key to. It must be an active project of your organization.
namestring · bodyNoA label for the key.Default Default.
scopeTypestring · bodyNoMust be project or left out.Default project.

The response is 201:

Response

FieldTypeDescription
idstring (uuid)The ID of the key.
keystringThe full secret of the key.
namestringThe label of the key.
projectIdstring (uuid) or nullThe key's project.
scopeTypestringAlways project.
createdAtstring (date-time)When the key was created.
updatedAtstring (date-time)When the key last changed.

Without projectId, the response is 400. A project key gets 403. When the project is not active or not in your organization, the response is 404.

In these examples, STEEL_API_KEY holds an organization key, and STEEL_PROJECT_ID holds the ID of the project. Projects shows how to find the ID.

See API keys.

curl -X POST https://api.steel.dev/v1/api-keys \
  -H "steel-api-key: $STEEL_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"projectId\": \"$STEEL_PROJECT_ID\", \"name\": \"ci\"}"