Soulhall Product handbook

Change language?

 Open Soulhall
Chapters

Research keys

Create personal research keys, check their state, and revoke or delete records when no longer needed.

A research key lets your tool read and write one Office’s research workspace without creating a Subject or summoning an Embodiment. Manage keys in Edgewright, separately from external service credentials in Connections & credentials.

Create and save a key

Create your own key before using Codex or Claude Code for Office research.

  1. Open Edgewright and select New key.
  2. Choose Office.
  3. Under Expiry, explicitly select Choose a date and enter a future date and time, or choose No expiry. The form has no default expiry.
  4. Select Create key. When it appears, select Copy, save it securely, then select Done.

The key record appears in the list with Office, state, and expiry. Next, connect your tool.

View key details

Several keys may belong to one Office. Use issuance time and ID to distinguish them before deciding which to keep.

  1. Open the action menu at the right of its row and select View details.
  2. Check Key ID, Office, State, Created, Expiry, and Last used. Other people’s keys also show Owner.

This displays records, not the key itself again.

Find why a key is unavailable

Read the state and reason before creating a replacement.

State Meaning and action
Active No known expiry, revocation, or access-condition problem. Still confirm connection and loaded tools in your tool.
Expired The expiry has passed. Create a new key to continue.
Revoked Permanently disabled. Create a new key to use research again.
Unavailable Required access conditions have a problem. Read the reason in the row or details first.

Possible reasons include:

  • You can no longer see the Office. Its name becomes Withheld office; the record stays so you can revoke it.
  • The holder’s membership, Office access, or required password change has a problem.
  • Office research is off. Re-enabling it restores keys that still meet other conditions.
  • The originally bound workspace no longer exists.

If details say the Office engine is unavailable, contact the operator. Another key will not repair the engine. Active does not guarantee engine health either.

Revoke a key you no longer need

Do not wait for expiry when a project ends or a key may have leaked.

  1. Open its row’s action menu and select Revoke.
  2. Check the Office, issuance time, and ID in the confirmation, then confirm.

The state becomes Revoked, and the record stays listed. Revocation is irreversible. Later requests using it are rejected; evaluations already submitted do not stop.

Delete a revoked record

  1. Select Delete in a Revoked key’s action menu, check the confirmation, and confirm.
  2. The record disappears irreversibly. This deletes the key record, not the research workspace or results.

Even Expired keys must first be revoked with Revoke before their records can be deleted.

Check who can manage which keys

Role Key records they can view, revoke, and delete
Manager Keys they created in the current organization.
Admin, Owner Everyone’s keys in the current organization.

Viewing records does not reveal another person’s key. Each key follows its holder’s current access, checked on use. It does not preserve permissions from issuance.