Skip to content

Projects

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 separates the work of one environment or product from the rest of your organization. Sessions, profiles, credentials and Quick actions belong to a project, and a project key reaches only its own project. Use projects to keep staging apart from production, or one product apart from another. Every organization has a default project, named Default project. Projects and namespaces explains what a project holds.

The plan limits, such as concurrent sessions, apply to the whole organization, not to each project. See Limits.

Before you begin

Put your Steel API key in the STEEL_API_KEY environment variable, and install the Steel SDK for your language: TypeScript, Python, Go or Rust.

Create a project

An organization admin creates projects in the dashboard. Members who are not admins, and API keys, cannot create, change or delete projects.

  1. Open the project menu at the top of the dashboard. It shows the current project's name.
  2. Click Create project.
  3. Under Name your project, type a name.
  4. To make it a production project, turn on Production.
  5. Click Create project.

The dashboard switches to the new project. Steel makes the slug from the name. The project menu also has View & manage projects, which opens Project Settings. There an admin can create, rename, promote and delete projects, and copy each project ID.

A project has these properties:

PropertyRule
Name1 to 100 characters
SlugLower-case letters, digits and hyphens. It must be unique in the organization.
ProductionA project is a development project or a production project. Promoting a development project to production cannot be undone.
DefaultOne project of the organization is the default. The default project cannot be deleted.

After you create a project, create a key for it. See API keys.

Switch projects

Each interface picks its project in its own way:

InterfaceHow to use another project
Your code, with a project keyUse a key of the other project
Your code, with an organization keyPass the other project's ID in projectId
MCP server, with sign-inSign in again, and pick the other project
MCP server, with an API keyUse a key of the other project

In the dashboard, open the project menu at the top of the page, and click the other project. Each project in the menu has a Prod or Dev badge. The dashboard then shows that project's sessions, API keys, profiles and credentials. It remembers your choice for each organization. Until you choose, it uses the default project.

Use a project from the API

To use a project from your code, you need its ID. This program lists the projects that your key reaches, with their IDs.

projects.mts
import Steel from "steel-sdk";

const client = new Steel();
const { projects } = await client.projects.list();

for (const project of projects) {
  console.log(project.id, project.name, project.isDefault ? "(default)" : "");
}

Run the program:

npx tsx projects.mts

With an organization key, the program prints every project in the organization. With a project key, it prints only the key's project.

e4aa5c83-05bd-49eb-a83f-d36f710976b0 Default project (default)

What projectId does depends on your key's scope:

  • A project key always uses its own project. Steel does not read projectId from the request.
  • An organization key needs projectId to create a session, run a Quick action, or work with profiles or credentials. Without it, the request gets a 400 error. A list of sessions covers every project unless you pass projectId.

With an organization key, pass the ID when you create a session:

const session = await client.sessions.create({
  projectId: process.env.STEEL_PROJECT_ID,
});

The session runs in that project, and the response's projectId field shows it. Release the session in a finally block, as in Create a session. In Go, release it in a defer. In Rust, release it after the async block. Every endpoint for projects is on Projects API.

Check that it worked

Open the project menu at the top of the dashboard. It lists the new project, with a Prod badge if you turned on Production, or Dev if not. With an organization key, the program in Use a project from the API prints the new project's ID and name. A session that you create with that ID has it in projectId, and it is among that project's sessions in the dashboard.

Next steps