Org

An org represents a company, team, workspace, or any other organization within which you will create your AI characters.

  {
      "id": "6509bbf39a93db7d92f77320",
      "name": "AABBCC",
      "createdAt": "2023-09-19T15:19:14.991Z",
      "description": "The official AABBCC account",
      "updatedAt": "2023-12-23T19:40:14.572Z",
      "address": {
          "city": "Almere",
          "country": "NL",
          "line1": "Londenhof 100",
          "line2": "",
          "postalCode": "1111AB",
          "state": ""
      },
      "email": "chieze.franklin@gmail.com",
      "phone": "+31687123456",
      "image": "https://proteusai-dev.s3.amazonaws.com/orgs/logos/6587379bb84c00a4056161bd",
      "subscription": {
          "collectionMethod": "CHARGE_AUTOMATICALLY",
          "currency": "usd",
          "expiresAt": "2023-10-19T15:19:42.000Z",
          "plan": "ENTERPRISE",
          "provider": "STRIPE",
          "status": "TRIALING"
      },
  }

Properties

address ^{Address optional}

The billing address of the org.

characters ^{Character[] can be included}

The characters belonging to the org.

createdAt ^Date

The creation date for the org.

description ^string

The description of the org.

email ^{string optional}

The contact (and billing) email of the org.

id ^string

The unique ID of the org. You can find your org's ID by visiting the org's page on ProteusAI. The org ID is located at the end of the URL.

E.g. the org ID for https://www.proteusai.app/65229d91c97b88f642a4f4e2 is 65229d91c97b88f642a4f4e2

image ^{string optional}

The image URL of the org.

invoices ^{Invoice[] can be included}

The invoices belonging to the org.

members ^{Membership[] can be included}

The members of the org.

name ^string

The name of the org.

phone ^{string optional}

The contact phone number of the org.

subscription ^Subscription

The subscription details of the org.

updatedAt ^Date

The last update date for the org.