Skip to content

Account & Organization Management#

This guide will show you how to manage your account and organization settings in the Orca App.

To deploy OrcaDB instances, visually browse your memory tables, and curate memories, you will need an account on the Orca App.

Log in and Join Your Organization#

Orca is currently in early access, so you will need an invite to create an account and deploy an instance.

Contact us to get an invite to try out Orca   :lucide-rocket:

If you have already received an invite to Orca, head to the Orca App at app.orcadb.ai to log in and join your organization. You will be greeted by a login screen that allows you to sign in with your Google or Microsoft powered work email account. Make sure to sign in with an email that matches the one you received the invite on.

Curate login Curate login

After signing in for the first time, you should see a screen that allows you to join the organization that is associated with your work email address. This organization was created by the person who invited you to Orca. Click the join button to join the organization.

Join organization Join organization

The first user to join the organization will be given owner status for the organization. All subsequent users will be added as members, but owners can change the role of any user in the organization.

Manage Organization Members#

To manage the members of your organization navigate to the :lucide-hotel: Organization Tab by clicking on your name and picture in the bottom left of the navigation sidebar and then selecting organization.

Organization settings Organization settings

Member Roles#

We have two roles: member and owner.

Owners have the following special permissions:

  • Updating roles of organization members
  • Deploying and managing new instances
  • Viewing and regenerating instance credentials

Invite Members#

If you are using a company email domain (e.g. @your-company.com). By default any user with a company email will be able to join as a member without an invite.

If you are an owner, you can also invite new members to your organization by clicking the invite button. This will open a dialog where you can enter the email address of the person you want to invite. The invited person will receive an email with a link to join the organization. If your organization is using a company email domain, you will not be able to invite users with non-company emails.

Pending invites will be listed at the bottom of the organization members list.

Invite members Invite members

Invites expire after 1 month. If the invite expires, you can send a new invite to the same email address. To revoke an invite, click the button on the right side of the invite in the list.

Edit Roles and Remove Members#

Owners can edit roles or remove members by clicking on the three dots next to their name which will open a dialog with options to change the role or remove the member.

Change account settings Change account settings

Manage API Keys#

To manage API keys for accessing the OrcaCloud API directly or via the SDK, navigate to the :lucide-hotel: Organization Tab by clicking on your name and picture in the bottom left of the navigation sidebar and then selecting organization.

You will see a list of API keys under the list of members.

Create an API Key#

To create an API key, click the “Create” button in the top right of the API keys list. Then enter a unique name and choose a scope for the API key and click “Create API Key”.

Create API Key Create API Key

API Key Scopes

The API key scope determines what actions that API key can perform. The two scopes are:

  • ADMINISTER: Can do anything, including creating and deleting organizations, models, and API keys.
  • PREDICT: Can only perform actions related to predictions, including making predictions, editing predictions, and adding feedback to predictions.

You will be shown a dialog with the API key. This is the only time you will see the API key, so make sure to save it in a secure location. You can copy the API key to your clipboard by clicking on it.

Copy API Key Copy API Key

Revoke an API Key#

To revoke an API key, click the revoke icon on the right side of the API key in the list and confirm that you want to revoke the API key.

Use API Key in the SDK#

There are two ways to use API keys with the Orca SDK:

This is the recommended way to use API keys with the Orca SDK. You simply need to create an environment variable with the name ORCA_API_KEY and the SDK will automatically pick it up.

For local development, you can for example load the API key from a git ignored .env file.

.env
ORCA_API_KEY=<your-api-key>

Then you can use the python-dotenv package to load the API key from the .env file with the load_dotenv function.

1
2
3
4
5
from dotenv import load_dotenv
from orca_sdk import OrcaCredentials

load_dotenv() # (1)!
assert OrcaCredentials.is_authenticated() # (2)!

  1. This loads the API key from the .env file into the environment variables. Make sure this code runs before you make any calls with the Orca SDK.
  2. This verifies that the SDK was able to pick up the API key from the environment variables.

You can also set the API key manually using the OrcaCredentials.set_api_key method.

1
2
3
from orca_sdk import OrcaCredentials

OrcaCredentials.set_api_key('<your-api-key>') # (1)!

  1. This sets the API key in the SDK and will raise an error if the API key is invalid. If you need to set the API key without making a network call to check it’s validity, set the check_validity parameter of the method to False.

Use API Key in HTTP Requests#

To use the API key in HTTP requests to the OrcaCloud API, you simply set it as the value of the Api-Key header.

1
2
curl -X GET "https://api.orcadb.ai/auth/" \ # (1)!
     -H "Api-Key: <your-api-key>"

  1. The /auth endpoint will return a 200 status code if the API key is valid and a 401 status code otherwise.