FactorAI

API keys

Create, scope, and revoke a personal API key for the Developer API.

An API key authenticates a request to the Developer API. Every key is personal: it acts as the team member who issued it and stays bounded by that member's live team permissions.

Before you start

You need a team and a role that may issue personal API keys. A member without that permission can open the API keys page but cannot create or edit a key.

Create a key

  1. Open FactorAI and select the team.
  2. Open Settings, then API keys.
  3. Select Generate new key.
  4. Enter a name of at most 120 characters that identifies the caller, such as production deploy.
  5. Choose an expiration of 30, 60, 90, or 365 days. A new key defaults to 30 days.
  6. Allow only the API actions the caller needs.
  7. Select Generate key.
  8. Copy the token when it appears. It starts with sk_live_ and is shown once; the list shows only its prefix afterwards.

The key list shows the name, token prefix, permissions, issuer, expiration, last use, and status: active, expired, or revoked.

Permissions

A key carries two layers of permission:

  • A capability level for each family, from none up to read or manage.
  • Action grants, the exact action ids a mutating request may attempt, such as workflow.control or run.dispatch.

Allowing an action raises its family capability to the level that action requires, so a key never carries a grant its capability cannot express. The team or project permission policy is still evaluated last and can deny the request or require approval. A grant never widens what the issuing member may do.

See API overview for the capability levels and the full action list.

Edit a key

Select a key and choose Edit to rename it, change its action permissions, or reset its expiration to 30, 60, 90, or 365 days from today. The token does not change.

Revoke a key

Select Revoke and confirm. Revocation takes effect immediately: applications using the key lose access, and the key cannot be restored. Create a new key instead.

Use the key

Send the token to https://api.factorai.ai as Authorization: Bearer <key> or in the x-api-key header. GET /v1/me reports the key's effective team, capabilities, and action grants.