Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.organizations.create({
        name: "string",
    });
}
main();

{
  "organization": {
    "lineShapeDefault": "curved",
    "name": "string",
    "oauthLandscapeWriteEnabled": true,
    "shareLinkAuthDomains": [
      "string"
    ],
    "shareLinksEnabled": true,
    "autoInviteDomains": [
      "string"
    ],
    "billingPaymentMethod": true,
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "plan": "free",
    "seats": 1.1,
    "status": "active",
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "userIds": [
      "string"
    ],
    "users": {},
    "aiFeatures": {
      "generateDetailedDescriptions": true,
      "generateDisplayDescriptions": true,
      "generateDraftSummary": true,
      "generateObjectSummary": true
    },
    "aiFeaturesEnabled": true,
    "aiModel": "gpt-5",
    "billingCurrency": "usd",
    "billingCycle": "monthly",
    "billingEmail": "string",
    "experiments": {},
    "language": "en-US",
    "billingCollectionMethod": "charge",
    "billingMonthlyCost": 1.1,
    "cancelAt": "2024-01-15T09:30:00Z",
    "canceledAt": "2024-01-15T09:30:00Z",
    "planEndsAt": "2024-01-15T09:30:00Z",
    "trialEndsAt": "2024-01-15T09:30:00Z"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Request

This endpoint expects an object.

namestringRequired<=4000 characters

aiFeaturesobjectOptional

AI features that are enabled for the organization

aiFeaturesEnabledbooleanOptionalDefaults to true

Whether to enable all AI features for the organization

aiModelenumOptional

billingCurrencyenumOptional

billingCycleenumOptional

billingEmailstringOptionalformat: "email"

experimentsmap from strings to booleansOptional

languageenumOptional

lineShapeDefaultenumOptional

oauthLandscapeWriteEnabledbooleanOptionalDefaults to true

Whether OAuth connections can make changes to landscape data

shareLinkAuthDomainslist of strings or nullOptional

shareLinksEnabledbooleanOptional

Response

organizationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error