Devbox
Devbox-ShellTools

Asynchronously execute a command via the Devbox shell

Changed on

Execute the given command in the Devbox shell asynchronously and returns the execution that can be used to track the command's progress.

post/v1/devboxes/{id}/execute_async

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/devboxes/{id}/execute_async
  • Auth: HTTP bearer

Path parameters

idstring required

The Devbox ID.

Request body

commandstring required

The command to execute via the Devbox shell. By default, commands are run from the user home directory unless shell_name is specified. If shell_name is specified the command is run from the directory based on the recent state of the persistent shell.

shell_namestring nullable

The name of the persistent shell to create or use if already created. When using a persistent shell, the command will run from the directory at the end of the previous command and environment variables will be preserved.

attach_stdinboolean nullable

Whether to attach stdin streaming for async commands. Not valid for execute_sync endpoint. Defaults to false if not specified.

Response

OK

devbox_idstring required

Devbox id where command was executed.

execution_idstring required

Ephemeral id of the execution in progress.

status'queued' | 'running' | 'completed' required
shell_namestring nullable

Shell name.

stdoutstring nullable

Standard out generated by command. This field will remain unset until the execution has completed.

stderrstring nullable

Standard error generated by command. This field will remain unset until the execution has completed.

exit_statusinteger nullable

Exit code of command execution. This field will remain unset until the execution has completed.

stdout_truncatedboolean nullable

Indicates whether the stdout was truncated due to size limits.

stderr_truncatedboolean nullable

Indicates whether the stderr was truncated due to size limits.

Changes

  • d3ddb452754cRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • 63df0e3eb49dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status