Create a directory | Vercel REST API

APIs & SDKs

Create a directory

POSThttps://api.vercel.com/v2/sandboxes/sessions/{sessionId}/fs/mkdir

Creates a new directory in a session's filesystem. By default, parent directories are created recursively if they don't exist (similar to mkdir -p).

https://api.vercel.com/v2/sandboxes/sessions/{sessionId}/fs/mkdir

const response = await fetch('https://api.vercel.com/v2/sandboxes/sessions/sessionId/fs/mkdir?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "cwd": "/home/vercel-sandbox",
    "path": "src/components",
    "recursive": "true"
  }),
});

const data = await response.json();
console.log(data);

Response

"value"

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

sessionIdstringRequired

The unique identifier of the session to create the directory in.

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

cwdstringOptional

The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory.

pathstringRequired

The path of the directory to create. Can be absolute or relative to the working directory.

recursivebooleanOptional

If true, creates parent directories as needed (like mkdir -p). If false, fails if parent directories do not exist.

Response

200The directory was created successfully.

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

422Error

429Error

500Error

Cross-link map: Create a directory (/docs/rest-api/sandboxes/create-a-directory)

From the Vercel docs graph (built 2026-10-10T05:32:43.016Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Get or create a drive — POST /v2/sandboxes/drives/{name} — Gets an existing drive by project and name, or creates it when it does not exist.
List sandboxes — GET /v2/sandboxes — Retrieves a paginated list of named sandboxes belonging to a specific project. Results can be sorted
Create a snapshot — POST /v2/sandboxes/sessions/{sessionId}/snapshot — Creates a point-in-time snapshot of a running session's filesystem. S
Execute a command — POST /v2/sandboxes/sessions/{sessionId}/cmd — Executes a shell command inside a running session. The command runs asynch
Delete a sandbox — DELETE /v2/sandboxes/{name} — Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first.

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v2/sandboxes/sessions/{sessionId}/fs/mkdir

const response = await fetch('https://api.vercel.com/v2/sandboxes/sessions/sessionId/fs/mkdir?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "cwd": "/home/vercel-sandbox",
    "path": "src/components",
    "recursive": "true"
  }),
});

const data = await response.json();
console.log(data);

Response

"value"

OpenAPI Specification