Droid Execute API

Start a headless Droid turn in one call: on a fresh computer from an Environment, an existing computer, or an existing session.

POST/api/v0/droid/execute

Execute a Droid turn

Starts a headless Droid turn and returns once it is accepted. Target an `environment` to provision a fresh computer from its active build and start a new session, a `computer` you own to start a new session on it, or a `session` you own to send a follow-up message. `model` and `reasoningEffort` apply only to new sessions. The session status can still show the previous turn as `idle` right after this call, so do not treat the first `idle` as completion. The accepted turn is complete when `GET /api/v0/sessions/{sessionId}` reports `idle` and `GET /api/v0/sessions/{sessionId}/messages` contains an assistant message after the user message whose `id` is the returned `messageId`.

cURL
curl -X POST 'https://api.factory.ai/api/v0/droid/execute' \
  -H 'Authorization: Bearer $FACTORY_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Request body

promptstringrequired
targetobjectrequired
variantenvironment
kindstringrequired

Allowed values

environment
environmentIdstringrequired
templateIdnot allowed
executionTemplateIdnot allowed
computerIdnot allowed
sourceComputerIdnot allowed
sessionIdnot allowed
varianttemplate
kindstringrequired

Allowed values

template
templateIdstringrequired
environmentIdnot allowed
executionTemplateIdnot allowed
computerIdnot allowed
sourceComputerIdnot allowed
sessionIdnot allowed
variantcomputer
kindstringrequired

Allowed values

computer
computerIdstringrequired
environmentIdnot allowed
templateIdnot allowed
executionTemplateIdnot allowed
sourceComputerIdnot allowed
sessionIdnot allowed
variantsession
kindstringrequired

Allowed values

session
sessionIdstringrequired
environmentIdnot allowed
templateIdnot allowed
executionTemplateIdnot allowed
computerIdnot allowed
sourceComputerIdnot allowed
modelstring
reasoningEffortstring

Allowed values

nonedynamicoffminimallowmediumhighxhighmax

Responses

202Response for status 202
sessionIdstringrequired
computerIdstringrequired
messageIdstringrequired
400Response for status 400
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

401Response for status 401
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

402Response for status 402
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

403Response for status 403
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

404Response for status 404
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

409Response for status 409
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

413Response for status 413
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

429Response for status 429
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

500Response for status 500
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

503Response for status 503
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values

504Response for status 504
detailstringrequired

Human-readable error message

statusnumberrequired

HTTP status code

titlestringrequired

HTTP status title

metadataobject (map)

Additional error metadata

Values