Orgs

The key's org, and org creation for platform keys.

Method	Path	Scope	Summary
POST	/orgs/	platform	Create Org
PATCH	/orgs/{slug}/plan	bearer	Set Plan
GET	/orgs/me	any key	My Org
POST	/orgs/self-serve	bearer	Self Serve

Try it

curl -sf -H "Authorization: Bearer $VIGIL_KEY" "$VIGIL_URL/orgs/me"

Routes

POST /orgs/

Create Org. Scope: platform.

Request body:

{
  "slug": "string",
  "name": "string"
}

Field	Type	Required	Notes
slug	string	yes
name	string	yes

Response 200:

{
  "id": 0,
  "slug": "string",
  "name": "string",
  "created_at": "2026-09-08T00:00:00Z",
  "plan": "string",
  "limits_json": "string | null",
  "billing_email": "string | null",
  "signup_ip_hash": "string | null"
}

PATCH /orgs/{slug}/plan

Set Plan. Scope: bearer.

Change an org's plan, override single limits, or set the billing email. Changing the plan clears overrides.

Parameter	In	Required	Type	Notes
slug	path	yes	string

Request body:

{
  "plan": "string | null",
  "limits": {},
  "billing_email": "string | null"
}

Field	Type	Required	Notes
plan	string | null	no
limits	object | null	no
billing_email	string | null	no

Response 200:

{
  "id": 0,
  "slug": "string",
  "name": "string",
  "created_at": "2026-09-08T00:00:00Z",
  "plan": "string",
  "limits_json": "string | null",
  "billing_email": "string | null",
  "signup_ip_hash": "string | null"
}

GET /orgs/me

My Org. Scope: any key.

Response 200:

{
  "id": 0,
  "slug": "string",
  "name": "string",
  "created_at": "2026-09-08T00:00:00Z",
  "plan": "string",
  "limits_json": "string | null",
  "billing_email": "string | null",
  "signup_ip_hash": "string | null"
}

POST /orgs/self-serve

Self Serve. Scope: bearer.

Create a free-pilot org and its first admin key without a bearer key. Refuses with a plain 400 on a malformed or reserved slug, a malformed address or a disposable domain; 409 when the slug is taken; 429 past LIMITS["self_serve"] for one client address. The client address is stored as a sha256 hash for abuse review, never raw.

Request body:

{
  "slug": "string",
  "name": "string",
  "email": "string"
}

Field	Type	Required	Notes
slug	string	yes
name	string	yes
email	string	yes

Response 200:

{
  "org": {
    "id": 0,
    "slug": "string",
    "name": "string",
    "created_at": "2026-09-08T00:00:00Z",
    "plan": "string",
    "limits_json": "string | null",
    "billing_email": "string | null",
    "signup_ip_hash": "string | null"
  },
  "api_key": "string"
}

Generated from openapi.json (VIGIL 0.2.0). Scopes follow the router dependencies in VIGIL_SPEC.md section 4.2.