Run a shell command in the actor's sandbox session

POST

/api/workspaces/{workspaceId}/apps/{id}/exec

curl --request POST \
  --url http://localhost:8080/api/workspaces/example/apps/example/exec \
  --header 'Content-Type: application/json' \
  --cookie auth_session=<auth_session> \
  --data '{ "command": "example", "cwd": "example", "timeoutMs": 1 }'

• Configured API base URL

Executes in the session working tree via the configured sandbox provider, then flushes the working tree to the durable WIP ref.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

id

required

string

Request Body

Media typeapplication/json

object

command

required

string

>= 1 characters

cwd

string

timeoutMs

integer

> 0 <= 600000

Example ^generated

{
  "command": "example",
  "cwd": "example",
  "timeoutMs": 1
}

Responses

2XX

Successful response

Media typeapplication/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}