Imports

Execute an import

post/imports/execute

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/imports/execute
  • Auth: HTTP bearer

Request body

directorystring required

Project directory

dry_runboolean nullable

Dry run mode (don't create resources)

main_branchstring required

Main branch name

presetstring required

Preset to use for the project (e.g., "nextjs", "express", "docker")

project_namestring required

Project name to use (overrides the name from the plan)

session_idstring required

Session ID from plan creation

Example request

{
  "directory": ".",
  "main_branch": "main",
  "project_name": "my-app"
}

Response

Import execution started

deployment_idinteger nullable

Created deployment ID (if completed)

environment_idinteger nullable

Created environment ID (if completed)

project_idinteger nullable

Created project ID (if completed)

session_idstring required

Session ID

status'pending' | 'inprogress' | 'completed' | 'failed' required

Import execution status

Changes

No recorded changes to this operation across all 53 revisions of this API.