Skip to main content
POST
/
api
/
v2
/
external
/
execution
/
image
/
start
Start Docker Execution
curl --request POST \
  --url https://api.lyceum.technology/api/v2/external/execution/image/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "docker_image_ref": "<string>",
  "docker_run_cmd": [
    "<string>"
  ],
  "docker_run_env": "<string>",
  "docker_registry_credential_type": "<string>",
  "aws_access_key_id": "<string>",
  "aws_secret_access_key": "<string>",
  "aws_session_token": "<string>",
  "region": "us-east-1",
  "timeout": 60,
  "execution_type": "cpu",
  "file_name": "<string>",
  "enable_s3_mount": true,
  "user_callback_urls": [
    "<string>"
  ]
}
'
{
  "execution_id": "<string>",
  "status": "<string>",
  "streaming_url": "<string>"
}

Body

application/json

Request model for Docker container execution

​
docker_image_ref
string
required

Docker image reference (e.g., python:3.9)

​
docker_run_cmd
string[]
required

Command to run in the container

​
docker_run_env
string | null

Environment variables as string

​
docker_registry_credential_type
string | null

Registry auth type (e.g., 'aws', 'basic')

​
aws_access_key_id
string | null

AWS Access Key ID for ECR

​
aws_secret_access_key
string | null

AWS Secret Access Key for ECR

​
aws_session_token
string | null

AWS Session Token for ECR

​
region
string | null
default:us-east-1

AWS region for ECR

​
timeout
integer
default:60
Required range: 1 <= x <= 600
​
execution_type
string
default:cpu
​
file_name
string | null
​
enable_s3_mount
boolean
default:true

Whether to enable S3 mount for this execution

​
user_callback_urls
string[] | null

URLs to call with job completion info

Response

Successful Response

Response from starting a Docker execution. Contains execution_id for tracking and streaming_url for real-time output logs.

​
execution_id
string
required
​
status
string
required
​
streaming_url
string
required