Skip to content

Workspace API ​

The API section lists your workspace's API keys for the REST API and MCP server. API access is available to Team workspaces only and supports read and write access to project data.

The section is visible to users with the View API keys permission. The key list shows each key's Name, Key, Permissions, Created date, and Last used date.

The API section of a Team workspace in Arcweave, showing API keys and their Read and Write permissions.

Create API keys ​

To create a new API key, you need the Create API key permission:

  1. Click Create new key.
  2. Give your key a descriptive name to help you remember its purpose.
  3. Under Project permissions, select Read projects, Write projects, or both. You must select at least one permission.
  4. Click Create.

The new key will appear in your API key list. Its Permissions column shows Read and/or Write badges.

Project permissions ​

Read projects is selected by default when you create a key. It allows listing, viewing, and exporting projects and their content. This is the permission needed by the Unity, Unreal Engine, and Godot integrations to import project data.

Write projects allows creating, importing, updating, and deleting projects and their content. It does not include read access: select both permissions when your integration needs to read and write data.

These key permissions work together with the workspace and project permissions of the member who created the key. A key cannot grant access beyond that member's permissions. If that member is removed from the workspace, the key is transferred to the workspace's longest-standing remaining Owner and uses that Owner's permissions from then on. See REST API permissions for the requirements for each operation.

Keys that existed before project permissions were introduced were assigned both Read projects and Write projects. Review their permissions and edit any key that should only read project data.

Remove API keys ​

To delete an existing API key:

  1. Find the key in the list.
  2. Click the settings icon (three dots) at the end of the row.
  3. Select Remove.
  4. Confirm the deletion by clicking Delete in the modal.

Edit API keys ​

To rename an existing API key or change its permissions:

  1. Locate the key in the list.
  2. Click the settings icon (three dots) at the end of the row.
  3. Select Edit key.
  4. Update the name and/or Project permissions, then click Save.

Permission changes apply immediately to the same key. Removing a permission causes requests that require it to return 403 Forbidden.

You can edit or remove your own keys with Create API key permission. Manage API permission lets you edit or remove any key in the workspace.

Copy API keys ​

To copy an API key to your clipboard:

  1. Find the key in the list.
  2. In the Key column, click the clipboard icon.

The key will now be copied to your device's clipboard. Store it securely and keep it out of public repositories and applications distributed to end users.

⚠️ Keys remain copyable from this list after creation. Every user with View API keys permission can copy any key in the workspace, including keys created by other members.