organization

Create Organization

Create an organization with the caller as its owner.

No API key is minted: creating a tenant and handing out a credential are separate decisions, and a key nobody asked for is a key nobody rotates.

post/api/v1/organizations

Request

Request body

display_namestring required

What to call it, e.g. 'Acme Audit' or 'Yera Personal'.

Response

Successful Response

organization_idstring uuid required
namestring required

Storage-safe slug, derived server-side. Stable; not shown to users.

display_namestring required

The name a human gave the organization.

role'owner' | 'admin' | 'member' required

The signed-in user's role here. It may differ per organization.

rate_limit_rpminteger required
included_creditsinteger nullable

Lifetime credit allowance; null means unlimited.

joined_atstring date-time required
created_atstring date-time required
default_workspace_idstring uuid nullable

The signed-in user's Perception Playground in this organization — where the console's perception tools upload by default. Null when it has not been provisioned yet, which the console handles by falling back to workspace-free uploads.

Changes

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