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

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)

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

Create Project

Request Body

Responses

201Project created successfully

400Bad Request - Invalid request body or parameters

500Internal Server Error - An unexpected server error occurred

Get Project

Responses

200Project details retrieved successfully

401Unauthorized - Invalid or missing authentication credentials

404Not Found - The requested resource was not found

500Internal Server Error - An unexpected server error occurred

Request OTP

Request Body

Responses

400Bad Request - Invalid parameters or request body

404Project not found or OTP record not found

429OTP rate limit exceeded

500Internal Server Error