Orishare
Api

Create a user, an organization with a default project and two environments, and a first token

POST
/auth/signup

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/auth/signup" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "organization_name": "Acme Audiobooks",    "timezone": "America/New_York"  }'
{  "user": {    "id": "string",    "email": "string",    "name": "string",    "created_at": "string"  },  "organization": {    "id": "string",    "name": "string",    "slug": "string"  },  "project": {    "id": "string",    "name": "string"  },  "environments": [    {      "id": "string",      "name": "string",      "runtime_class": "string"    }  ],  "token": {    "id": "string",    "token": "string",    "scopes": [      "string"    ]  }}

Exchange a verified Identity Platform ID token for a 30-day session; the user is created on first sign-in, organizations come from POST /organizations or an invitation

POST
/auth/sessions

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/auth/sessions" \  -H "Content-Type: application/json" \  -d '{    "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ij…"  }'
{  "user": {    "id": "string",    "email": "string",    "name": "string",    "created_at": "string"  },  "created": true,  "memberships": [    {      "organization_id": "string",      "user_id": "string",      "email": "string",      "role": "owner",      "created_at": "string"    }  ],  "token": {    "id": "string",    "token": "string",    "scopes": [      "string"    ],    "expires_at": "string"  }}

Create another organization owned by the caller, with a default project and two environments

POST
/organizations

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme Audiobooks",    "timezone": "Europe/Amsterdam"  }'
{  "organization": {    "id": "string",    "name": "string",    "slug": "string"  },  "project": {    "id": "string",    "name": "string"  },  "environments": [    {      "id": "string",      "name": "string",      "runtime_class": "string"    }  ]}

The caller and their memberships

GET
/users/me

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users/me"
{  "id": "string",  "email": "string",  "name": "string",  "created_at": "string",  "memberships": [    {      "organization_id": "string",      "user_id": "string",      "email": "string",      "role": "owner",      "created_at": "string"    }  ]}

List the caller's tokens

GET
/auth/tokens

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/auth/tokens"
{  "data": [    {      "id": "string",      "name": "string",      "prefix": "string",      "scopes": [        "string"      ],      "expires_at": "string",      "last_used_at": "string",      "created_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Issue a personal access token with scopes

POST
/auth/tokens

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/auth/tokens" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "scopes": [      "string"    ]  }'
{  "id": "string",  "name": "string",  "prefix": "string",  "scopes": [    "string"  ],  "expires_at": "string",  "last_used_at": "string",  "created_at": "string",  "token": "string"}

Revoke a token (the current one included)

DELETE
/auth/tokens/{id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/auth/tokens/string"
Empty

Invite a user by email with a role

POST
/organizations/{id}/invitations

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/organizations/string/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "role": "owner"  }'
{  "id": "string",  "organization_id": "string",  "email": "string",  "role": "owner",  "expires_at": "string",  "accepted_at": "string",  "created_at": "string",  "token": "string"}

Accept an invitation with its token; creates the user when needed and returns a first token (existing users sign in instead)

POST
/invitations/{id}/accept

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/invitations/string/accept" \  -H "Content-Type: application/json" \  -d '{    "token": "stringstri"  }'
{  "user": {    "id": "string",    "email": "string",    "name": "string",    "created_at": "string"  },  "membership": {    "organization_id": "string",    "user_id": "string",    "email": "string",    "role": "owner",    "created_at": "string"  },  "token": {    "id": "string",    "token": "string",    "scopes": [      "string"    ]  }}

List members

GET
/organizations/{id}/memberships

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/organizations/string/memberships"
{  "data": [    {      "organization_id": "string",      "user_id": "string",      "email": "string",      "role": "owner",      "created_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Change a member's role

PATCH
/organizations/{id}/memberships/{user_id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
user_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/organizations/string/memberships/string" \  -H "Content-Type: application/json" \  -d '{    "role": "admin"  }'
{  "organization_id": "string",  "user_id": "string",  "email": "string",  "role": "owner",  "created_at": "string"}

Remove a member (never the last owner)

DELETE
/organizations/{id}/memberships/{user_id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
user_id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/organizations/string/memberships/string"
Empty

Transfer ownership to another member; the caller becomes admin

POST
/organizations/{id}/transfer_ownership

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/organizations/string/transfer_ownership" \  -H "Content-Type: application/json" \  -d '{    "user_id": "string"  }'
{  "owner": {    "organization_id": "string",    "user_id": "string",    "email": "string",    "role": "owner",    "created_at": "string"  },  "previous_owner": {    "organization_id": "string",    "user_id": "string",    "email": "string",    "role": "owner",    "created_at": "string"  }}

AI drafting

Describe a campaign in plain language; get validated rule documents to review, simulate and publish.

Ai

AI drafting: plain-English requests become validated rule documents for review; never published by the model.