Factory

App · 25 actions

Create and manage Droid sessions, read messages, computers, environments, organization usage and AutoWiki content.

Actions

ActionWhat it does
Add a message to a sessionAdd a message to a session.
Create a sessionCreate a session.
Delete a sessionDelete a session.
Get a computerGet a computer.
Get a message by IDGet a message by ID.
Get a sessionGet a session.
Get a wiki pageGet a wiki page.
Get a wiki runGet a wiki run.
Get an EnvironmentGet an Environment.
Get computer metricsGet computer metrics.
Get Factory Environment Build DiagnosticsGet Factory Environment Build Diagnostics.
Get global user credits limitGet global user credits limit.
Get session messagesGet session messages.
Interrupt a sessionInterrupt a session.
List a session's child sessionsList a session's child sessions.
List available computer providersList available computer providers.
List available Factory Environment sourcesList available Factory Environment sources.
List computersList computers.
List current Factory Environment build statusesList current Factory Environment build statuses.
List Factory Environments visible to the callerList Factory Environments visible to the caller.
List organization usersList organization users.
List sessionsList sessions.
List the latest wiki runsList the latest wiki runs.
Search a wiki runSearch a wiki run.
Update a sessionUpdate a session.

Add a message to a session

Add a message to a session.

Inputs

SessionIdsessionIdtextRequired
Sessionid
TexttexttextRequired
Message text content
Imagesimageslist
Optional base64-encoded images
Filesfileslist
Optional file attachments (PDFs, text files)
ComputerIdcomputerIdtext
Computer ID to route the message to; falls back to the session.computerId if omitted
Sendersenderobject
The mission session sending this message (the orchestrator, or an agent by name), stored on the message so clients can attribute it and the model sees a [From …] header. Omit for human messages.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "messageId": "example",
    "recipientDroidStatus": "idle",
    "status": "idle"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create a session

Create a session.

Inputs

ComputerIdcomputerIdtextRequired
Computer ID to connect
Cwdcwdtext
Working directory for the session on the computer.
SessionSettingssessionSettingsobject
Sessionsettings

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "artifacts": [],
    "completedAt": 0,
    "computerId": "example",
    "createdAt": 0,
    "factoryCredits": 0,
    "messageCount": 0,
    "parent_session_id": "example",
    "sessionId": "example",
    "sessionSettings": {
      "allowSubagentsInScripts": false,
      "apiProviderLock": "bedrock",
      "archivedAt": "example",
      "autonomyLevel": "off",
      "autonomyMode": "normal",
      "compactionModel": "example",
      "compactionThresholdCheckEnabled": false,
      "disabledToolIds": [],
      "enabledToolIds": [],
      "interactionMode": "auto",
      "model": "example",
      "providerLock": "anthropic",
      "providerLockTimestamp": "example",
      "reasoningEffort": "none",
      "restrictToolIds": [],
      "specModeModel": "example",
      "specModeReasoningEffort": "none",
      "tags": [],
      "toolExecutionMode": "direct_only",
      "worktree": {
        "branch": "example",
        "lifecycle": "ephemeral",
        "parentWorktreePath": "example",
        "path": "example",
        "removedAt": "example",
        "repoRoot": "example",
        "setupProfileId": "example"
      }
    },
    "status": "idle",
    "title": "example",
    "updatedAt": 0
  },
  "has_more": false,
  "next_cursor": "example"
}

Delete a session

Delete a session.

Inputs

SessionIdsessionIdtextRequired
Session ID
ComputerIdcomputerIdtext
Computer ID to query directly

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get a computer

Get a computer.

Inputs

ComputerIdcomputerIdtextRequired
Computer ID

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "clonedRepoDirectories": [],
    "computerIdentity": {
      "algorithm": "X25519",
      "keyId": "example",
      "publicKey": "example",
      "updatedAt": 0
    },
    "computerSource": {
      "kind": "template",
      "templateId": "example"
    },
    "createdAt": 0,
    "hostId": "11111111-1111-4111-8111-111111111111",
    "id": "example",
    "isListed": false,
    "name": "example",
    "ownerId": "example",
    "ownerPrincipalKind": "example",
    "providerType": "example",
    "provisioningSteps": [],
    "relayAgentUrl": "example",
    "relayClientUrl": "example",
    "remoteUser": "example",
    "status": "provisioning"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get a message by ID

Get a message by ID.

Inputs

SessionIdsessionIdtextRequired
Session ID
MessageIdmessageIdtextRequired
Message ID
ComputerIdcomputerIdtext
Computer ID to query directly

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "apiProvider": "bedrock",
    "chatCompletionReasoningContent": "example",
    "chatCompletionReasoningField": "reasoning",
    "content": [],
    "createdAt": 0,
    "geminiThoughtSignature": "example",
    "hiddenFromUserViews": false,
    "hookCommands": [],
    "hookEndTime": 0,
    "hookEventName": "example",
    "hookMatcher": "example",
    "hookOrder": 0,
    "hookParentId": "example",
    "hookPreventedAction": false,
    "hookResults": [],
    "hookStartTime": 0,
    "hookStatus": "executing",
    "hookToolCallId": "example",
    "id": "example",
    "interactionMode": "auto",
    "isError": false,
    "isParallelExecution": false,
    "isUserVisible": false,
    "modelId": "example",
    "openaiEncryptedContent": "example",
    "openaiMessageId": "example",
    "openaiPhase": "commentary",
    "openaiReasoningId": "example",
    "openaiReasoningSummary": "example",
    "parallelGroupId": "example",
    "parentId": "example",
    "reasoningEffort": "none",
    "role": "user",
    "routerId": "example",
    "sender": {
      "kind": "orchestrator",
      "sessionId": "example"
    },
    "seq": 0,
    "updatedAt": 0,
    "userMessageSource": "web",
    "visibility": "both"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get a session

Get a session.

Inputs

SessionIdsessionIdtextRequired
Session ID
ComputerIdcomputerIdtext
Computer ID to query directly

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "artifacts": [],
    "completedAt": 0,
    "computerId": "example",
    "createdAt": 0,
    "factoryCredits": 0,
    "messageCount": 0,
    "parent_session_id": "example",
    "sessionId": "example",
    "sessionSettings": {
      "allowSubagentsInScripts": false,
      "apiProviderLock": "bedrock",
      "archivedAt": "example",
      "autonomyLevel": "off",
      "autonomyMode": "normal",
      "compactionModel": "example",
      "compactionThresholdCheckEnabled": false,
      "disabledToolIds": [],
      "enabledToolIds": [],
      "interactionMode": "auto",
      "model": "example",
      "providerLock": "anthropic",
      "providerLockTimestamp": "example",
      "reasoningEffort": "none",
      "restrictToolIds": [],
      "specModeModel": "example",
      "specModeReasoningEffort": "none",
      "tags": [],
      "toolExecutionMode": "direct_only",
      "worktree": {
        "branch": "example",
        "lifecycle": "ephemeral",
        "parentWorktreePath": "example",
        "path": "example",
        "removedAt": "example",
        "repoRoot": "example",
        "setupProfileId": "example"
      }
    },
    "status": "idle",
    "title": "example",
    "updatedAt": 0
  },
  "has_more": false,
  "next_cursor": "example"
}

Get a wiki page

Get a wiki page.

Inputs

WikiRunIdwikiRunIdtextRequired
Wikirunid
PageIdpageIdtextRequired
Pageid

Outputs

dataobject
AutoWiki response; its shape is not specified by the published contract.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get a wiki run

Get a wiki run.

Inputs

WikiRunIdwikiRunIdtextRequired
Wikirunid

Outputs

dataobject
AutoWiki response; its shape is not specified by the published contract.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get an Environment

Get an Environment.

Inputs

EnvironmentIdenvironmentIdtextRequired
Environmentid

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "activeRepositories": [],
    "activeSource": {
      "id": "example",
      "name": "example",
      "provider": {
        "id": "example",
        "name": "example"
      },
      "supportsRepositories": false,
      "supportsSetupScripts": false,
      "unavailable": true
    },
    "createdAt": 0,
    "failureReason": "example",
    "id": "example",
    "isDefault": false,
    "lastSuccessfulBuildAt": 0,
    "latestBuild": {
      "createdAt": 0,
      "excerpt": "example",
      "failureCategory": "source-resolution",
      "failureReason": "example",
      "finishedAt": 0,
      "id": "example",
      "promotedAt": 0,
      "repositories": [],
      "startedAt": 0,
      "status": "queued",
      "trigger": "create",
      "truncated": false,
      "withheld": false
    },
    "name": "example",
    "repositories": [],
    "scope": "user",
    "setupScript": "example",
    "source": {
      "id": "example",
      "name": "example",
      "provider": {
        "id": "example",
        "name": "example"
      },
      "supportsRepositories": false,
      "supportsSetupScripts": false,
      "unavailable": true
    },
    "status": "building",
    "updatedAt": 0
  },
  "has_more": false,
  "next_cursor": "example"
}

Get computer metrics

Get computer metrics.

Inputs

ComputerIdcomputerIdtextRequired
Computer ID
Startstartdate and time
Start of time range (ISO 8601)

Outputs

datalist
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

Get Factory Environment Build Diagnostics

Get Factory Environment Build Diagnostics.

Inputs

EnvironmentIdenvironmentIdtextRequired
Environmentid

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "buildId": "example",
    "excerpt": "example",
    "status": "building",
    "truncated": false,
    "withheld": false
  },
  "has_more": false,
  "next_cursor": "example"
}

Get global user credits limit

Get global user credits limit.

Inputs

None.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "limit": null
  },
  "has_more": false,
  "next_cursor": "example"
}

Get session messages

Get session messages.

Inputs

SessionIdsessionIdtextRequired
Sessionid
Limitlimittext
Maximum number of items to return (1-100)
Cursorcursortext
Cursor for pagination
ComputerIdcomputerIdtext
Computer ID to query directly
Roleroletext
Filter messages by roleOne of: user, assistant, tool.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "messages": [],
    "pagination": {
      "hasMore": false,
      "nextCursor": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}

Interrupt a session

Interrupt a session.

Inputs

SessionIdsessionIdtextRequired
Sessionid

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "status": "idle"
  },
  "has_more": false,
  "next_cursor": "example"
}

List a session's child sessions

List a session's child sessions.

Inputs

SessionIdsessionIdtextRequired
The parent session id
IncludeArtifactsincludeArtifactstext
Whether to include each child session’s integration artifacts (pull requests, issues, pages).One of: true, false.
IncludeAttentionincludeAttentiontext
Whether to include what each child session is waiting on (a permission prompt or a question).One of: true, false.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "sessions": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List available computer providers

List available computer providers.

Inputs

None.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "providers": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List available Factory Environment sources

List available Factory Environment sources.

Inputs

None.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "providers": [],
    "unavailableProviders": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List computers

List computers.

Inputs

HostIdhostIdtext
Hostid
ServiceAccountIdserviceAccountIdtext
Look up a service account’s Computers (requires human Manager+).
IncludeProvisioningStepsincludeProvisioningStepstext
Whether to include provisioning step details.One of: true, false.
IncludeUnlistedincludeUnlistedtext
Whether to include Computers hidden from normal listings.One of: true, false.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "computers": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List current Factory Environment build statuses

List current Factory Environment build statuses.

Inputs

EnvironmentIdsenvironmentIdslistRequired
Environmentids
ServiceAccountIdserviceAccountIdtext
Serviceaccountid

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "builds": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List Factory Environments visible to the caller

List Factory Environments visible to the caller.

Inputs

ServiceAccountIdserviceAccountIdtext
Serviceaccountid

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "defaultEnvironmentId": "example",
    "environments": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List organization users

List organization users.

Inputs

Limitlimittext
Maximum number of items to return (1-100)
Cursorcursortext
Cursor for pagination

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "pagination": {
      "hasMore": false,
      "nextCursor": null
    },
    "users": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List sessions

List sessions.

Inputs

Limitlimittext
Maximum number of items to return (1-100)
Cursorcursortext
Cursor for pagination
ComputerIdcomputerIdtext
Computer ID to query directly

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "pagination": {
      "hasMore": false,
      "nextCursor": null
    },
    "sessions": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List the latest wiki runs

List the latest wiki runs.

Inputs

None.

Outputs

dataobject
AutoWiki response; its shape is not specified by the published contract.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Search a wiki run

Search a wiki run.

Inputs

WikiRunIdwikiRunIdtextRequired
Wikirunid

Outputs

dataobject
AutoWiki response; its shape is not specified by the published contract.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Update a session

Update a session.

Inputs

SessionIdsessionIdtextRequired
Session ID
SessionSettingssessionSettingsobject
Sessionsettings

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "artifacts": [],
    "completedAt": 0,
    "computerId": "example",
    "createdAt": 0,
    "factoryCredits": 0,
    "messageCount": 0,
    "parent_session_id": "example",
    "sessionId": "example",
    "sessionSettings": {
      "allowSubagentsInScripts": false,
      "apiProviderLock": "bedrock",
      "archivedAt": "example",
      "autonomyLevel": "off",
      "autonomyMode": "normal",
      "compactionModel": "example",
      "compactionThresholdCheckEnabled": false,
      "disabledToolIds": [],
      "enabledToolIds": [],
      "interactionMode": "auto",
      "model": "example",
      "providerLock": "anthropic",
      "providerLockTimestamp": "example",
      "reasoningEffort": "none",
      "restrictToolIds": [],
      "specModeModel": "example",
      "specModeReasoningEffort": "none",
      "tags": [],
      "toolExecutionMode": "direct_only",
      "worktree": {
        "branch": "example",
        "lifecycle": "ephemeral",
        "parentWorktreePath": "example",
        "path": "example",
        "removedAt": "example",
        "repoRoot": "example",
        "setupProfileId": "example"
      }
    },
    "status": "idle",
    "title": "example",
    "updatedAt": 0
  },
  "has_more": false,
  "next_cursor": "example"
}

On this page