CI Automations API

Manage CI automation workflows: scan repositories, list jobs, and open workflow PRs.

POST/api/v0/automations/ci/edit

Open a CI workflow PR (create / edit / delete)

Creates, updates, or deletes a repository CI workflow and opens the resulting changes as a pull request.

cURL
curl -X POST 'https://api.factory.ai/api/v0/automations/ci/edit' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
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

GET/api/v0/automations/ci/jobs

List CI automation jobs

Returns the CI automation jobs available to the authenticated organization.

cURL
curl 'https://api.factory.ai/api/v0/automations/ci/jobs' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
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

GET/api/v0/automations/ci/repositories

List CI-eligible repositories

Returns repositories that are eligible for Factory CI automation.

cURL
curl 'https://api.factory.ai/api/v0/automations/ci/repositories' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
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

GET/api/v0/automations/ci/repository-owners

List CI repository owners

Returns repository owners available when configuring Factory CI automation.

cURL
curl 'https://api.factory.ai/api/v0/automations/ci/repository-owners' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
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

GET/api/v0/automations/ci/runs

List GitHub Actions runs for CI automation workflows

List GitHub Actions runs for CI automation workflows.

cURL
curl 'https://api.factory.ai/api/v0/automations/ci/runs' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
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

GET/api/v0/automations/ci/scan

Scan repositories for CI workflows

Scans connected repositories and reports their Factory CI workflow configuration.

cURL
curl 'https://api.factory.ai/api/v0/automations/ci/scan' \
  -H 'Authorization: Bearer $FACTORY_API_KEY'

Responses

200Response for status 200
401Response for status 401
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