Archbee CLI Authentication Guide
9 min
Authentication Overview
Most Archbee CLI API commands require:
- --api-key
- --doc-space-id
Example:
archbee search-docs --api-key YOUR_API_KEY --doc-space-id YOUR_SPACE_IDTypes of API Keys
Space API Keys
Space API keys are scoped to a single documentation space.
You can generate them from:
Space Settings → API keysTeam API Keys
Team API keys start with:
abteam_Team admins can create them from:
Settings → DeveloperTeam API keys can access multiple spaces.
When --doc-space-id Is Required
Most commands require a --doc-space-id value even when using a team API key.
Example:
archbee get-doc --api-key abteam_xxx --doc-space-id SPACE_IDCommands That Do Not Require --doc-space-id
These team-level commands can run using only a team API key:
- export
- display-rules
- create-space
- upload
- list-files
- delete-file
- move-file
- replace-file
Read-Only API Keys
Read-only team API keys cannot modify content.
Commands such as these will fail with read-only keys:
- create-doc
- delete-doc
- publish-space
- update-space
Authentication Troubleshooting
Invalid API Key
Verify:
- The key has not expired
- The key belongs to the correct team or space
- There are no extra spaces or quotes in the command
Space Access Errors
Make sure the API key has permission to access the specified space.
Command Permission Denied
Use a write-enabled team key for commands that change data.
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.