Account

List Limit Requests

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/v1/limits/requests"

{  "object": "list",  "data": [    {      "id": "tkt_01J9ZK2K4Q7Q3M3QX1V0F1TKT1",      "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",      "kind": "limit_increase",      "status": "open",      "subject": "limit increase beyond plan for production",      "body": {        "key_id": "key_01J9ZK2K4Q7Q3M3QX1V0F1KEY1",        "rpm": 100000,        "reason": "launch"      },      "created_by": "[email protected]",      "created_at": "2026-09-08T10:00:00Z"    }  ]}

Request Limit Increase

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

key_id*string

rpm?integer

tpm?integer

concurrency?integer

reason?string

`application/json`

curl -X POST "https://example.com/v1/limits/requests" \  -H "Content-Type: application/json" \  -d '{    "key_id": "key_01J9ZK2K4Q7Q3M3QX1V0F1KEY1",    "rpm": 300,    "reason": "launch"  }'

{  "status": "approved",  "applied": {    "rpm": 300,    "tpm": 2000000,    "concurrency": 32  },  "ticket": {    "id": "tkt_01J9ZK2K4Q7Q3M3QX1V0F1TKT1",    "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",    "kind": "limit_increase",    "status": "approved",    "subject": "limit increase for production",    "body": {      "key_id": "key_01J9ZK2K4Q7Q3M3QX1V0F1KEY1",      "rpm": 300,      "reason": "launch"    },    "created_by": "[email protected]",    "created_at": "2026-09-08T10:00:00Z"  }}

List Tickets

Authorization

bearer

AuthorizationBearer <token>

In: header

Query Parameters

kind?unknown

Value in

"limit_increase"
"invoice_correction"
"refund"
"close_org"
"other"

`application/json`

curl -X GET "https://example.com/v1/tickets"

{  "object": "list",  "data": [    {      "id": "tkt_01J9ZK2K4Q7Q3M3QX1V0F1TKT1",      "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",      "kind": "limit_increase",      "status": "open",      "subject": "limit increase beyond plan for production",      "body": {        "key_id": "key_01J9ZK2K4Q7Q3M3QX1V0F1KEY1",        "rpm": 100000,        "reason": "launch"      },      "created_by": "[email protected]",      "created_at": "2026-09-08T10:00:00Z"    }  ]}

Create Support Ticket

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subject*string

Length3 <= length <= 200

body?string

Lengthlength <= 5000

`application/json`

curl -X POST "https://example.com/v1/tickets" \  -H "Content-Type: application/json" \  -d '{    "subject": "Requests timing out",    "body": "Since this morning some requests time out."  }'

{  "id": "tkt_01J9ZK2K4Q7Q3M3QX1V0F1TKT1",  "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0CHILD",  "kind": "other",  "status": "open",  "subject": "Requests timing out",  "body": {    "text": "Since this morning some requests time out."  },  "created_by": "[email protected]",  "created_at": "2026-10-02T08:00:00Z"}

List Own Announcements

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/v1/announcements"

{  "object": "list",  "data": [    {      "id": "ann_01J9ZK2K4Q7Q3M3QX1V0F1ANN1",      "title": "Maintenance on Saturday",      "body": "Requests may be slower between 02:00 and 03:00 UTC.",      "severity": "info",      "starts_at": "2026-10-02T00:00:00Z"    }  ]}

Preview Redaction

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

presets?array<>

patterns?array<string>

sample?string

Lengthlength <= 65536

`application/json`

curl -X POST "https://example.com/v1/policy/redact/preview" \  -H "Content-Type: application/json" \  -d '{    "presets": [      "email",      "pan"    ],    "sample": "mail [email protected] PAN ABCDE1234F"  }'

{  "input": "mail [email protected] PAN ABCDE1234F",  "output": "mail [REDACTED:email] PAN [REDACTED:pan]",  "redactions": 2,  "presets": [    "api_key",    "card",    "aadhaar",    "pan",    "email",    "phone"  ]}

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/v1/signup"

{  "invite_only": true,  "needs_invite": true,  "waitlist": {    "id": "wl_01J9ZK2K4Q7Q3M3QX1V0F1GATE",    "user_id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1GATE",    "email": "[email protected]",    "company": "Acme",    "use_case": "support bot",    "status": "pending",    "created_at": "2026-09-30T10:00:00Z"  }}

Join Waitlist

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

company?string

Lengthlength <= 200

use_case?string

Lengthlength <= 2000

`application/json`

curl -X POST "https://example.com/v1/signup/waitlist" \  -H "Content-Type: application/json" \  -d '{    "company": "Acme",    "use_case": "support bot over our docs"  }'

{  "id": "wl_01J9ZK2K4Q7Q3M3QX1V0F1GATE",  "user_id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1GATE",  "email": "[email protected]",  "company": "Acme",  "use_case": "support bot over our docs",  "status": "pending",  "created_at": "2026-09-30T10:00:00Z"}

Request Access

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

the work address the activation link is sent to

name*string

Lengthlength <= 200

company*string

Lengthlength <= 200

job_title?string

Lengthlength <= 200

country*string

ISO 3166-1 alpha-2

Length2 <= length <= 2

website?string

Lengthlength <= 300

use_case*string

Lengthlength <= 2000

monthly_spend?string

expected spend a month in US dollars

Value in

""
"under_100"
"100_1000"
"1000_10000"
"over_10000"

accept_terms*boolean

the terms and the privacy notice were accepted

turnstile_token?string

the solved bot check, when the cell asks for one

`application/json`

curl -X POST "https://example.com/v1/access-requests" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "name": "Dana Rao",    "company": "Example Labs",    "job_title": "CTO",    "country": "IN",    "website": "https://example.com",    "use_case": "support agents over our product docs",    "monthly_spend": "100_1000",    "accept_terms": true  }'

{  "status": "received"}

Get Activation

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

token*string

`application/json`

curl -X POST "https://example.com/v1/access-requests/activation" \  -H "Content-Type: application/json" \  -d '{    "token": "3q2-7wEAAQIDBAUGBwgJCgsMDQ4PEBESExQVFhcYGRo"  }'

{  "email": "[email protected]",  "name": "Dana Rao",  "expires_at": "2026-10-12T10:00:00Z"}

Activate Access

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

token*string

password*string

Length8 <= length <= 256

`application/json`

curl -X POST "https://example.com/v1/access-requests/activate" \  -H "Content-Type: application/json" \  -d '{    "token": "3q2-7wEAAQIDBAUGBwgJCgsMDQ4PEBESExQVFhcYGRo",    "password": "correct horse battery staple"  }'

{  "email": "[email protected]",  "status": "activated"}

Get Challenge

`application/json`

curl -X GET "https://example.com/v1/challenge"

{  "object": "challenge",  "provider": "turnstile",  "site_key": "0x4AAAAAAAexample",  "action": "create_org"}

Get D P A

Authorization

bearer

AuthorizationBearer <token>

In: header

`text/html`

`application/json`

curl -X GET "https://example.com/v1/documents/dpa"

"string"

Close Org

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

confirm*string

refund_requested?boolean

`application/json`

curl -X POST "https://example.com/v1/orgs/string/close" \  -H "Content-Type: application/json" \  -d '{    "confirm": "acme",    "refund_requested": true  }'

{  "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "acme",  "name": "Acme",  "kind": "team",  "billing_country": "IN",  "billing_currency": "INR",  "legal_name": "Acme Pvt Ltd",  "gstin": "23AAAAA0000A1ZA",  "tax_status": "gst_registered",  "plan_id": "payg",  "status": "closed",  "role": "owner",  "billing_email": "[email protected]",  "billing_address": {    "line1": "1 MG Road",    "city": "Indore",    "state_code": "23",    "postal_code": "452001",    "country": "IN"  },  "settings": {    "security": {      "require_2fa": false,      "session_hours": 12,      "console_ip_allow": [],      "key_default_expiry_days": 0    }  },  "data_policy": {    "logging": "on",    "retention_days": 30,    "zdr": false,    "no_train": false,    "regions": [],    "redact": {      "presets": [        "api_key",        "card"      ],      "patterns": []    }  },  "created_at": "2026-09-01T10:00:00Z",  "closed_at": "2026-09-11T09:00:00Z"}

Request Erasure

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X POST "https://example.com/v1/orgs/string/erasure"

{  "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "acme",  "name": "Acme",  "kind": "team",  "billing_country": "IN",  "billing_currency": "INR",  "legal_name": "Acme Pvt Ltd",  "gstin": "23AAAAA0000A1ZA",  "tax_status": "gst_registered",  "plan_id": "payg",  "status": "active",  "role": "owner",  "billing_email": "[email protected]",  "billing_address": {    "line1": "1 MG Road",    "city": "Indore",    "state_code": "23",    "postal_code": "452001",    "country": "IN"  },  "settings": {    "security": {      "require_2fa": false,      "session_hours": 12,      "console_ip_allow": [],      "key_default_expiry_days": 0    }  },  "data_policy": {    "logging": "on",    "retention_days": 30,    "zdr": false,    "no_train": false,    "regions": [],    "redact": {      "presets": [        "api_key",        "card"      ],      "patterns": []    }  },  "created_at": "2026-09-01T10:00:00Z",  "erasure_requested_at": "2026-09-11T09:00:00Z",  "erasure_due_at": "2026-10-11T09:00:00Z"}

Cancel Erasure

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X DELETE "https://example.com/v1/orgs/string/erasure"

{  "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "acme",  "name": "Acme",  "kind": "team",  "billing_country": "IN",  "billing_currency": "INR",  "legal_name": "Acme Pvt Ltd",  "gstin": "23AAAAA0000A1ZA",  "tax_status": "gst_registered",  "plan_id": "payg",  "status": "active",  "role": "owner",  "billing_email": "[email protected]",  "billing_address": {    "line1": "1 MG Road",    "city": "Indore",    "state_code": "23",    "postal_code": "452001",    "country": "IN"  },  "settings": {    "security": {      "require_2fa": false,      "session_hours": 12,      "console_ip_allow": [],      "key_default_expiry_days": 0    }  },  "data_policy": {    "logging": "on",    "retention_days": 30,    "zdr": false,    "no_train": false,    "regions": [],    "redact": {      "presets": [        "api_key",        "card"      ],      "patterns": []    }  },  "created_at": "2026-09-01T10:00:00Z"}

Transfer Ownership

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

user_id*string

`application/json`

curl -X POST "https://example.com/v1/orgs/string/transfer" \  -H "Content-Type: application/json" \  -d '{    "user_id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1USR2"  }'

{  "owner": "usr_01J9ZK2K4Q7Q3M3QX1V0F1USR2",  "previous_owner_role": "admin"}

List Projects

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/v1/projects"

{  "object": "list",  "data": [    {      "id": "prj_01J9ZK2K4Q7Q3M3QX1V0F1PRJ1",      "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",      "slug": "default",      "name": "Default",      "environment": "live",      "status": "active",      "budget": {        "monthly_micro": 500000000,        "hard": false      },      "spend_today_micro": 12500000,      "spend_month_micro": 61000000,      "created_at": "2026-09-01T10:00:00Z"    }  ]}

Create Project

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug*string

name*string

environment?unknown

Value in

"live"
"test"

`application/json`

curl -X POST "https://example.com/v1/projects" \  -H "Content-Type: application/json" \  -d '{    "slug": "mobile",    "name": "Mobile",    "environment": "live"  }'

{  "id": "prj_01J9ZK2K4Q7Q3M3QX1V0F1PRJ2",  "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "mobile",  "name": "Mobile",  "environment": "live",  "status": "active",  "budget": {    "monthly_micro": 500000000,    "hard": false  },  "spend_today_micro": 12500000,  "spend_month_micro": 61000000,  "created_at": "2026-09-01T10:00:00Z"}

Get Project

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/v1/projects/string"

{  "id": "prj_01J9ZK2K4Q7Q3M3QX1V0F1PRJ1",  "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "default",  "name": "Default",  "environment": "live",  "status": "active",  "budget": {    "monthly_micro": 500000000,    "hard": false  },  "spend_today_micro": 12500000,  "spend_month_micro": 61000000,  "created_at": "2026-09-01T10:00:00Z"}

Update Project

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

data_policy?

budget?

model_allow?array<string>

model_deny?array<string>

status?unknown

Value in

"active"
"paused"

`application/json`

curl -X PATCH "https://example.com/v1/projects/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Default (renamed)",    "budget": {      "monthly_micro": 500000000    }  }'

{  "id": "prj_01J9ZK2K4Q7Q3M3QX1V0F1PRJ1",  "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "default",  "name": "Default (renamed)",  "environment": "live",  "status": "active",  "budget": {    "monthly_micro": 500000000,    "hard": false  },  "spend_today_micro": 12500000,  "spend_month_micro": 61000000,  "created_at": "2026-09-01T10:00:00Z"}

List Orgs

Authorization

bearer

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/v1/orgs"

{  "object": "list",  "data": [    {      "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",      "slug": "acme",      "name": "Acme",      "kind": "team",      "billing_country": "IN",      "billing_currency": "INR",      "legal_name": "Acme Pvt Ltd",      "gstin": "23AAAAA0000A1ZA",      "tax_status": "gst_registered",      "plan_id": "payg",      "status": "active",      "role": "owner",      "billing_email": "[email protected]",      "billing_address": {        "line1": "1 MG Road",        "city": "Indore",        "state_code": "23",        "postal_code": "452001",        "country": "IN"      },      "settings": {        "security": {          "require_2fa": false,          "session_hours": 12,          "console_ip_allow": [],          "key_default_expiry_days": 0        }      },      "data_policy": {        "logging": "on",        "retention_days": 30,        "zdr": false,        "no_train": false,        "regions": [],        "redact": {          "presets": [            "api_key",            "card"          ],          "patterns": []        }      },      "created_at": "2026-09-01T10:00:00Z"    }  ]}

Create Org

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

slug*string

name*string

billing_country*string

billing_currency?string

kind?unknown

Value in

"personal"
"team"
"enterprise"

turnstile_token?string

the solved bot challenge, required when GET /v1/challenge names one; refused with challenge_failed (403) or challenge_unavailable (503, retry)

invite_code?string

admits a person's first organization while signups are invite-only (GET /v1/signup); refused with invite_required, invite_invalid, invite_expired, invite_revoked or invite_used (403)

referral_code?string

attributes the new organization to the one that shared this code (the affiliate programme); a code naming no active organization, or the creator's own, is ignored

storefront_host?string

the domain of the reseller storefront the console is served on; the organization becomes that reseller's customer under the storefront's registration policy (storefront_closed, invite_required, storefront_not_found)

Response Body

`application/json`

curl -X POST "https://example.com/v1/orgs" \  -H "Content-Type: application/json" \  -d '{    "slug": "acme",    "name": "Acme",    "billing_country": "IN"  }'

{  "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "acme",  "name": "Acme",  "kind": "team",  "billing_country": "IN",  "billing_currency": "INR",  "legal_name": "Acme Pvt Ltd",  "gstin": "23AAAAA0000A1ZA",  "tax_status": "gst_registered",  "plan_id": "payg",  "status": "active",  "role": "owner",  "billing_email": "[email protected]",  "billing_address": {    "line1": "1 MG Road",    "city": "Indore",    "state_code": "23",    "postal_code": "452001",    "country": "IN"  },  "settings": {    "security": {      "require_2fa": false,      "session_hours": 12,      "console_ip_allow": [],      "key_default_expiry_days": 0    }  },  "data_policy": {    "logging": "on",    "retention_days": 30,    "zdr": false,    "no_train": false,    "regions": [],    "redact": {      "presets": [        "api_key",        "card"      ],      "patterns": []    }  },  "created_at": "2026-09-01T10:00:00Z"}

Get Org

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/orgs/string"

{  "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "acme",  "name": "Acme",  "kind": "team",  "billing_country": "IN",  "billing_currency": "INR",  "legal_name": "Acme Pvt Ltd",  "gstin": "23AAAAA0000A1ZA",  "tax_status": "gst_registered",  "plan_id": "payg",  "status": "active",  "role": "owner",  "billing_email": "[email protected]",  "billing_address": {    "line1": "1 MG Road",    "city": "Indore",    "state_code": "23",    "postal_code": "452001",    "country": "IN"  },  "settings": {    "security": {      "require_2fa": false,      "session_hours": 12,      "console_ip_allow": [],      "key_default_expiry_days": 0    }  },  "data_policy": {    "logging": "on",    "retention_days": 30,    "zdr": false,    "no_train": false,    "regions": [],    "redact": {      "presets": [        "api_key",        "card"      ],      "patterns": []    }  },  "created_at": "2026-09-01T10:00:00Z"}

Update Org

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

legal_name?string

gstin?string

pan?string

tax_status?unknown

Value in

"unregistered"
"gst_registered"
"export"
"sez"

billing_email?string

billing_address?

data_policy?

settings?

{"security": {"require_2fa", "session_hours", "console_ip_allow", "key_default_expiry_days"}}

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/orgs/string" \  -H "Content-Type: application/json" \  -d '{    "legal_name": "Acme Pvt Ltd",    "gstin": "23AAAAA0000A1ZA",    "tax_status": "gst_registered",    "billing_email": "[email protected]"  }'

{  "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "slug": "acme",  "name": "Acme",  "kind": "team",  "billing_country": "IN",  "billing_currency": "INR",  "legal_name": "Acme Pvt Ltd",  "gstin": "23AAAAA0000A1ZA",  "tax_status": "gst_registered",  "plan_id": "payg",  "status": "active",  "role": "owner",  "billing_email": "[email protected]",  "billing_address": {    "line1": "1 MG Road",    "city": "Indore",    "state_code": "23",    "postal_code": "452001",    "country": "IN"  },  "settings": {    "security": {      "require_2fa": false,      "session_hours": 12,      "console_ip_allow": [],      "key_default_expiry_days": 0    }  },  "data_policy": {    "logging": "on",    "retention_days": 30,    "zdr": false,    "no_train": false,    "regions": [],    "redact": {      "presets": [        "api_key",        "card"      ],      "patterns": []    }  },  "created_at": "2026-09-01T10:00:00Z"}

List Members

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/orgs/string/members"

{  "object": "list",  "data": [    {      "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",      "user_id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1USR1",      "role": "owner",      "email": "[email protected]",      "name": "Alice"    },    {      "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",      "user_id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1USR2",      "role": "viewer",      "email": "[email protected]",      "name": "Bob"    }  ]}

Add Member

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

org*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

role*Role

Value in

"owner"
"admin"
"billing"
"member"
"viewer"

Response Body

`application/json`

curl -X POST "https://example.com/v1/orgs/string/members" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "role": "member"  }'

{  "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "user_id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1USR3",  "role": "member",  "email": "[email protected]"}

Set Member Role

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

org*string

user*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*Role

Value in

"owner"
"admin"
"billing"
"member"
"viewer"

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/orgs/string/members/string" \  -H "Content-Type: application/json" \  -d '{    "role": "admin"  }'

{  "org_id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "user_id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1USR2",  "role": "admin"}

Remove Member

Authorization

bearer

AuthorizationBearer <token>

In: header

Path Parameters

org*string

user*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/orgs/string/members/string"

Empty

Response Body

`application/json`

curl -X GET "https://example.com/auth/login"

Empty

Console Callback

Response Body

`application/json`

curl -X GET "https://example.com/auth/callback"

Empty

Console Logout

Response Body

`application/json`

curl -X POST "https://example.com/auth/logout"

{  "logout_url": "https://auth.ai.ml/realms/aiml/protocol/openid-connect/logout?post_logout_redirect_uri=https%3A%2F%2Fconsole.ai.ml%2Flogin"}

Console Me

Authorization

bearer

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/auth/me"

{  "user": {    "id": "usr_01J9ZK2K4Q7Q3M3QX1V0F1USR1",    "email": "[email protected]",    "name": "Alice",    "status": "active"  },  "orgs": [    {      "id": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",      "slug": "acme",      "name": "Acme",      "kind": "team",      "billing_country": "IN",      "billing_currency": "INR",      "legal_name": "Acme Pvt Ltd",      "gstin": "23AAAAA0000A1ZA",      "tax_status": "gst_registered",      "plan_id": "payg",      "status": "active",      "role": "owner",      "billing_email": "[email protected]",      "billing_address": {        "line1": "1 MG Road",        "city": "Indore",        "state_code": "23",        "postal_code": "452001",        "country": "IN"      },      "settings": {        "security": {          "require_2fa": false,          "session_hours": 12,          "console_ip_allow": [],          "key_default_expiry_days": 0        }      },      "data_policy": {        "logging": "on",        "retention_days": 30,        "zdr": false,        "no_train": false,        "regions": [],        "redact": {          "presets": [            "api_key",            "card"          ],          "patterns": []        }      },      "created_at": "2026-09-01T10:00:00Z"    }  ],  "active_org": "org_01J9ZK2K4Q7Q3M3QX1V0F1ORG1",  "role": "owner"}

200application/json

defaultapplication/json

200application/json

202application/json

defaultapplication/json

200application/json

defaultapplication/json

201application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

202application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200text/html

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

201application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

defaultapplication/json

204

defaultapplication/json

200application/json

defaultapplication/json

201application/json

defaultapplication/json

200application/json

defaultapplication/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`text/html`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`