Skip to content
LogoLogo

Projects

Operations related to project management

Create Project

POST/register

Creates a new project with API keys and optional encryption key

Request Body

application/json
nameRequired
string

Name of the project

ExampleMy Project
generate_encryption_key
boolean

Whether to generate an encryption key during creation

Exampletrue
enable_2fa
boolean

Whether to require a one-time password for encryption sessions

Examplefalse

Responses

Get Project

GET/project

Retrieves project details

Responses

Prepare API Key Rotation

POST/project/rotate-api-key/prepare

Generates a pending API key and returns it. The current key keeps working until the rotation is committed with the pending key. Preparing again replaces the pending key. A pending key expires after 15 minutes.

Responses

Commit API Key Rotation

POST/project/rotate-api-key/commit

Send the pending key from prepare in X-API-Key, with the API secret. The pending key becomes current and the previous key stops working. Repeating the commit with the now-current key returns status: current, so a lost response is safe to retry.

Responses

Request OTP

POST/project/otp

Generate and send a one-time password (OTP) to a user via email or phone

Request Body

application/json
user_idRequired
string

The unique identifier of the user

dangerously_skip_verification
boolean·default false

Skip verification checks (use with caution)

email
string <email>

Email address to send OTP (mutually exclusive with phone)

phone
string

Phone number to send OTP (mutually exclusive with email)

Responses

200OTP generated and sent successfully

Presented By