Skip to content

Projects 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 →

A project groups your organization's sessions, profiles and API keys. These endpoints list your projects and get one of them. For the base URL and authentication, see API conventions. For the error codes, see Errors.

The first example is a complete program. The later examples use its client, and the ID of a project in PROJECT_ID (cURL), projectId (TypeScript), project_id (Python and Rust) or projectID (Go).

Endpoints

List projects

GET/v1/projects

Lists the projects that your API key reaches. An organization key gets every project in the organization, and a project key gets only its own project.

This endpoint takes no parameters.

Response

FieldTypeDescription
projectsobject[]The projects. Each one is a project object, as in Get a project.

See Projects.

curl https://api.steel.dev/v1/projects \
  -H "steel-api-key: $STEEL_API_KEY"

Get a project

GET/v1/projects/{id}

Returns one project.

Parameters

NameTypeRequiredDescription
idstring (uuid) · pathYesThe ID of the project.

Response

FieldTypeDescription
idstring (uuid)The ID of the project.
namestringThe name of the project.
slugstringSteel's short form of the name: lower-case letters, digits and hyphens, unique in the organization.
isDefaultbooleantrue for the organization's default project, which cannot be deleted.
isProductionbooleantrue for a production project, false for a development project.
promotedToProductionAtstring (date-time) or nullWhen the project became a production project.
createdAtstring (date-time)When the project was created.
updatedAtstring (date-time)When the project last changed.

See Projects.

curl https://api.steel.dev/v1/projects/$PROJECT_ID \
  -H "steel-api-key: $STEEL_API_KEY"