On this page

Compute environment status

GET/compute/status

Operation getComputeStatusAuthBearer token

Responses

StatusDescriptionBody
200StatusComputeStatus
statusrequiredstring

One of not_installed, machine_stopped, stopped, starting, running, error

containerNamerequiredstring
activeAgentsrequiredarray<string>
errorstring
leftRunningarray<object>

Containers this runtime's last stop (POST /compute/stop, shutdown) left running because another runtime on the machine uses them. Present only when non-empty. Cleared when this runtime starts a container (shared or per-agent) and by a stop that finds nothing running.

3 fields of leftRunning
namerequiredstring
holdersrequiredarray<string>

Runtimes using it, e.g. "studio-embedded pid 4242". Empty when the owner is unknown.

reasonrequiredstring
Errors 401 · 403 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl "http://127.0.0.1:7385/compute/status" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"
Response 200
{
  "status": "running",
  "containerName": "adf-mcp",
  "activeAgents": [
    "agent-1"
  ]
}

List ADF compute containers

GET/compute/containers

Operation listComputeContainersAuthBearer token

Responses

StatusDescriptionBody
200ContainersComputeContainersResponse
containersrequiredarray<ComputeContainer>
3 fields of containers
namerequiredstring
statusrequiredstring
runningrequiredboolean
Errors 401 · 403 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl "http://127.0.0.1:7385/compute/containers" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"

Start the shared compute environment

POST/compute/start

Operation startComputeAuthBearer token

No body.

Responses

StatusDescriptionBody
200Status after startComputeStatus

Fields as in ComputeStatus above.

Errors 401 · 403 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/start" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"
Response 200
{
  "status": "running",
  "containerName": "adf-mcp",
  "activeAgents": [
    "agent-1"
  ]
}

Stop the daemon's compute containers

POST/compute/stop

Operation stopComputeAuthBearer token

No body.

Responses

StatusDescriptionBody
200Status after stopComputeStatus

Fields as in ComputeStatus above.

Errors 401 · 403 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/stop" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"
Response 200
{
  "status": "running",
  "containerName": "adf-mcp",
  "activeAgents": [
    "agent-1"
  ]
}

Destroy the daemon's compute containers and images

POST/compute/destroy

Operation destroyComputeAuthBearer token

No body.

Responses

StatusDescriptionBody
200DestroyedComputeDestroyResponse
successrequiredboolean

Value true

statusrequiredobject

Fields as in ComputeStatus above.

Errors 401 · 403 · 405 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
405Not available on this daemon (the subsystem is read-only or lacks this operation)
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/destroy" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"

Run a compute setup step

POST/compute/setup

Operation setupComputeAuthBearer token

Studio's compute setup steps. check reports availability (Podman, machine, installMethods); any other step name is refused before Podman is probed. install runs installCommand only when it exactly matches the command of an autoRunnable entry in availability.installMethods from check (e.g. /opt/homebrew/bin/brew install podman); anything else is refused with "Install command is not one this runtime can run automatically" and nothing runs. Methods with a url are for the user to open; on Linux every method needs sudo, so install is always refused there. machine_init sizes the Podman machine from compute settings machineMemoryMb / machineCpus (missing, invalid or larger than the host: 2048 MB, 2 CPUs). Step failures answer 200 with success: false.

Request bodyapplication/json · ComputeSetupBody · required

FieldTypeDescription
steprequiredstring

One of install, machine_init, machine_start, check

installCommandstring

step=install: must exactly match an autoRunnable command in availability.installMethods from step=check; anything else is refused

Responses

StatusDescriptionBody
200Step outcomeComputeSetupResponse
successrequiredboolean
errorstring
availabilityobject

Podman availability: binPath, version, machine state, installMethods, prerequisites

Errors 400 · 401 · 403 · 405 · 500 · 503
400Invalid request: missing or malformed field, query parameter or body. A body Fastify cannot parse gets Fastify's own shape (statusCode, code, error, message).bad_requestFST_ERR_CTP_EMPTY_JSON_BODY
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
405Not available on this daemon (the subsystem is read-only or lacks this operation)
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/setup" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"step":"check"}'

Recent container exec log

GET/compute/exec-log

Operation getComputeExecLogAuthBearer token

Query parameters

NameTypeDescription
namestring

Only this container's entries

Responses

StatusDescriptionBody
200EntriesComputeExecLogResponse
entriesrequiredarray<ComputeExecLogEntry>
7 fields of entries
timestamprequiredinteger
containerNamerequiredstring
commandrequiredstring
exitCoderequiredinteger
stdoutrequiredstring

Truncated

stderrrequiredstring

Truncated

durationMsrequiredinteger
Errors 401 · 403 · 405 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
405Not available on this daemon (the subsystem is read-only or lacks this operation)
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl "http://127.0.0.1:7385/compute/exec-log" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"

One container's live detail

GET/compute/containers/{name}

Operation getComputeContainerAuthBearer token

Path parameters

NameTypeDescription
namerequiredstring

Container name

Responses

StatusDescriptionBody
200DetailComputeContainerDetail
successrequiredboolean

Value true

overviewrequiredobject | null

Parsed podman inspect summary

processesrequiredstring
packagesrequiredstring
workspacerequiredstring
logsrequiredstring
inspectrequiredstring

Raw podman inspect JSON

Errors 401 · 403 · 405 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
405Not available on this daemon (the subsystem is read-only or lacks this operation)
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl "http://127.0.0.1:7385/compute/containers/NAME" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"

Start one container

POST/compute/containers/{name}/start

Operation startComputeContainerAuthBearer token

No body.

Path parameters

NameTypeDescription
namerequiredstring

Container name

Responses

StatusDescriptionBody
200OutcomeSuccessResponse
successrequiredboolean
Errors 401 · 403 · 405 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
405Not available on this daemon (the subsystem is read-only or lacks this operation)
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/containers/NAME/start" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"
Response 200
{
  "success": true
}

Stop one container

POST/compute/containers/{name}/stop

Operation stopComputeContainerAuthBearer token

No body.

Path parameters

NameTypeDescription
namerequiredstring

Container name

Responses

StatusDescriptionBody
200OutcomeSuccessResponse
successrequiredboolean
Errors 401 · 403 · 405 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
405Not available on this daemon (the subsystem is read-only or lacks this operation)
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/containers/NAME/stop" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"
Response 200
{
  "success": true
}

Destroy one container

POST/compute/containers/{name}/destroy

Operation destroyComputeContainerAuthBearer token

No body.

Path parameters

NameTypeDescription
namerequiredstring

Container name

Responses

StatusDescriptionBody
200OutcomeSuccessResponse
successrequiredboolean
Errors 401 · 403 · 405 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
405Not available on this daemon (the subsystem is read-only or lacks this operation)
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/containers/NAME/destroy" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"
Response 200
{
  "success": true
}

Rebuild a container

POST/compute/containers/{name}/rebuild

Operation rebuildComputeContainerAuthBearer token

Path parameters

NameTypeDescription
namerequiredstring

Container name

Responses

StatusDescriptionBody
200OKContainerRebuildResponse
successrequiredboolean
recreatedboolean
errorstring
Errors 401 · 403
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/containers/NAME/rebuild" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"

Probe an external execution target

POST/compute/execution-targets/test

Operation testExecutionTargetAuthBearer token

Request bodyapplication/json · object · required

No fields.

Responses

StatusDescriptionBody
200OKExecutionTargetProbeResult
successboolean
errorstring
Errors 401 · 403
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/execution-targets/test" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Container phase and noVNC port of an agent

GET/compute/browser-info

Operation getComputeBrowserInfoAuthBearer token

Query parameters

NameTypeDescription
agentNamerequiredstring

Agent name

agentIdrequiredstring

Agent id

Responses

StatusDescriptionBody
200OKBrowserInfoResponse
containerNamerequiredstring
hostPortrequiredinteger | null

noVNC port on the daemon host loopback; null until the container is ready

phaserequiredstring
detailstring
Errors 400 · 401 · 403 · 503
400Invalid request: missing or malformed field, query parameter or body. A body Fastify cannot parse gets Fastify's own shape (statusCode, code, error, message).bad_requestFST_ERR_CTP_EMPTY_JSON_BODY
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl "http://127.0.0.1:7385/compute/browser-info?agentName=AGENT_NAME&agentId=AGENT_ID" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"

Stop the shared container

POST/compute/shared/stop

Operation stopSharedComputeContainerAuthBearer token

Studio's COMPUTE_STOP: stops the shared adf-mcp container only, and leaves it running while another live runtime on this machine uses it (GET /compute/status then lists it in leftRunning). POST /compute/stop stops every container this runtime started.

Responses

StatusDescriptionBody
200OKAgentSuccessOrError
successrequiredboolean
errorstring
Errors 401 · 403 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl -X POST "http://127.0.0.1:7385/compute/shared/stop" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"

Other runtimes using containers

GET/compute/users

Operation getComputeUsersAuthBearer token

For the shared container and each container in names: the other live runtimes on this machine that use it (daemon pid 4242). Containers nobody else uses are left out.

Query parameters

NameTypeDescription
namesstring

Comma-separated container names besides the shared one.

Responses

StatusDescriptionBody
200UsersComputeUsersResponse
usersrequiredmap<string, array<string>>
Errors 401 · 403 · 500 · 503
401Missing or wrong bearer token (unauthorized)
403The request guard refused it: Host header not allowed (host_not_allowed, DNS-rebinding protection) or a browser cross-site request (cross_origin)host_not_allowedcross_origin
500Unexpected runtime failure
503The subsystem is not configured on this daemon

Error bodies use the error format.

Example

Request
curl "http://127.0.0.1:7385/compute/users" \
  -H "Authorization: Bearer $ADF_DAEMON_TOKEN"