Agent accounts

Rename or rescope an agent account

patch/v1/agent-accounts/{id}

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/agent-accounts/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

UUIDv7, lowercase canonical form.

Query parameters

project_idstring uuid

UUIDv7, lowercase canonical form.

Request body

labelstring
positioninteger

Retired: the order no longer chooses the account; answers 409 account_pool_retired.

Response

Default Response

idstring uuid required

UUIDv7, lowercase canonical form.

labelstring required
emailstring nullable required
chatgpt_account_idstring nullable

Codex: the ChatGPT account (workspace) id its login signs in to, as tokens.account_id in ~/.codex/auth.json; null for Claude and when the login did not say. The Codex app opens a Cloud thread only while signed in to the thread’s account.

plan_typestring nullable required

Claude: pro, max, team, enterprise. Codex: plus, pro, team, business, enterprise. API keys: api.

owner_user_idstring uuid nullable required

UUIDv7, lowercase canonical form.

mineboolean required

The caller signed this account in (an API key counts as the member who created it).

positioninteger required

Order within the provider (the order the accounts were added), from 0.

activeboolean required

New conversations and every running conversation VM of this provider use this account’s login. One per provider (Claude: per organization; Codex: per project); you choose it with POST /agent-accounts/{id}/activate.

preferredboolean required

Deprecated: the same as active.

pool_eligibleboolean required

Deprecated: always false.

as_ofstring date-time nullable required

RFC 3339 UTC timestamp with Z.

staleboolean required

The newest reading is more than 30 minutes old.

threadsinteger required

Open conversations running on this account (the active account’s open conversations of its provider; 0 for the others).

can_activateboolean required

The caller can make this account active now: an owner or admin, a subscription sign-in with a working login, a team account or their own, of this project (ChatGPT), not already active.

can_removeboolean required

The caller can remove this account: it is theirs, or they are an owner or admin and it is not the active account while another could take its place.

created_atstring date-time required

RFC 3339 UTC timestamp with Z.

updated_atstring date-time required

RFC 3339 UTC timestamp with Z.

Changes

No recorded changes to this operation across all 1 revision of this API.