Factory API

Public API for Factory platform. Requires authentication via the `Authorization: Bearer` header.

Authentication

The Factory Public API authenticates every request with a bearer token. Pass your Factory API key in the Authorization header as a Bearer token. Requests without a valid API key receive a 401 response.

Factory API key or JWT token for authentication

Authorization header
Authorization: Bearer $FACTORY_API_KEY

Create an API key

Create API keys in the Factory App before you call the API. Keys are shown once, so copy the value immediately and store it in your secret manager or shell environment.

  1. Open Factory API keys settings.
  2. Create a new API key and give it a name that matches the integration.
  3. Copy the key, store it securely, and load it as an environment variable.
Environment variable
export FACTORY_API_KEY="fk-your-api-key"

Base URL

All endpoints are relative to the production base URL. Prepend it to each operation path shown on the group pages.

Base URL
https://api.factory.ai

API version 0.1.0

Resource groups

The API is organized into 6 resource groups. Each group page lists its operations with parameters, request and response schemas, and a curl example.

CI Automations API
Manage CI automation workflows: scan repositories, list jobs, and open workflow PRs.
OpenCI Automations API
Droid Computers API
Provision and manage Factory computers: create, inspect, refresh, restart, and delete.
OpenDroid Computers API
Organization Management API
Administer organization members and usage limits, and review enterprise control history.
OpenOrganization Management API
Service Accounts API
Manage service account API keys: list, create, rotate, and revoke.
OpenService Accounts API
Droid Sessions API
Create and drive Droid sessions: manage their lifecycle, settings, and messages.
OpenDroid Sessions API
AutoWiki API
Generate and manage AutoWiki runs: create runs, browse pages, search, and export.
OpenAutoWiki API