Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
The Organization object represents a workspace or company entity in the Freddy system. Organizations serve as the primary container for users, resources, AI configurations, and billing.

Properties

Identity

id string required

Unique organization identifier. Format: ORG_ followed by 16 alphanumeric characters (e.g., ORG_1234567890ABCDEF).

name string required

Organization display name.

type string required

Organization type. One of: Work, Personal, School.

Branding

logo_image string | null optional

Base64-encoded organization logo image. Automatically resized to 512x512 and compressed to ~200KB.

image_url string | null optional

Public URL to the organization's logo image.

Status & Configuration

is_active boolean required

Whether the organization is active and can be used. Default: true.

auth_key string required

Primary API authentication key for the organization (encrypted).

Resource Limits

api_usage_limit float optional

API usage spending limit in CHF. Default: 0.0 (no limit).

total_usage_limit float optional

Total usage spending limit in CHF. Default: 0.0 (no limit).

storage_free_bytes_allowance integer optional

Free storage allowance in bytes. Default: 52428800 (50MB).

Pricing

pricing_tier_id string | null optional

Reference to the organization's pricing tier. Default: tier_standard.

Domain Management

domain string | null optional

Primary email domain associated with the organization (e.g., aitronos.com). Unique across all organizations.

Timestamps

created_at string required

Timestamp when the organization was created. Format: ISO 8601 datetime string.

updated_at string required

Timestamp when the organization was last updated. Format: ISO 8601 datetime string.

Relationships

Organizations have the following related entities:

{
  "id": "ORG_A1B2C3D4E5F6G7H8",
  "name": "Aitronos Technologies",
  "type": "Work",
  "logo_image": null,
  "image_url": "https://cdn.freddy.aitronos.com/logos/ORG_A1B2C3D4E5F6G7H8.png",
  "is_active": true,
  "auth_key": "[ENCRYPTED]",
  "api_usage_limit": 500.0,
  "total_usage_limit": 1000.0,
  "storage_free_bytes_allowance": 52428800,
  "pricing_tier_id": "tier_enterprise",
  "domain": "aitronos.com",
  "created_at": "2025-01-10T09:00:00Z",
  "updated_at": "2025-01-15T14:30:00Z"
}