Default Organization

Tip

Please consult our Documentation to select the default organization from the UI.

Please consult our full Swagger API documentation for more details on our APIs.

When you sign up to Lynxius, the default organization named “Personal {username}” (e.g., Personal John), is automaticaly generated for you. You can use this organization, or create a new one, to start evaluating your LLM Apps right away! You can also invite new members to join your organizations.

Get Your Organizations

Retrieve the list of all your organizations.

Example Request

curl -X 'GET' \
  'https://platform.lynxius.ai/api/organizations/' \
  -H "Authorization: Bearer $JWT_ACCESS_TOKEN" \
  -H 'accept: application/json'

Returns

[
    {
        "uuid": "19fb4d6e-a19d-4cd5-bde4-98480a6e77a7",
        "name": "Personal USER-NAME",
        "balance": 0.0,
        "date_created": "2024-05-14T14:19:00.560532Z",
        "role": "OWNER",
        "is_default": false
    },
    {
        "uuid": "16c44188-8e99-4e79-938f-75a56a90577b",
        "name": "ORG-NAME-1",
        "balance": 19953.0,
        "date_created": "2024-05-14T16:13:56.270415Z",
        "role": "OWNER",
        "is_default": false
    },
    {
        "uuid": "e442aa01-3f95-43fe-bcf4-65cc0ca143b4",
        "name": "ORG-NAME-2",
        "balance": 90601.0,
        "date_created": "2024-05-01T06:59:02.100518Z",
        "role": "PARTICIPANT",
        "is_default": true
    }
]

Select Default Organization

Selects the desired default organization by providing it's uuid.

Example Request

curl -X 'POST' \
  'https://platform.lynxius.ai/api/organizations/default/' \
  -H "Authorization: Bearer $JWT_ACCESS_TOKEN" \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "uuid": "16c44188-8e99-4e79-938f-75a56a90577b"
}'

Returns

{
    "uuid": "16c44188-8e99-4e79-938f-75a56a90577b",
    "name": "ORG-NAME-1",
    "balance": 19953.0,
    "date_created": "2024-05-14T16:13:56.270415Z",
    "role": "OWNER",
    "is_default": true
}