Learn how to authenticate with the Buena.ai API using API keys
bna_[hexadecimal]
where the hexadecimal string is 64 characters long:
*
)x-api-key
header for all requests:
*
).
users:read
- Read user data and settings - users:write
- Modify user
data and settingslinkedin:schedule
- Schedule LinkedIn actions - linkedin:upload
-
Upload prospect lists - linkedin:read
- Read LinkedIn data -
linkedin:voice
- Send LinkedIn voice messagesleads:read
- Read lead data - leads:write
- Create/update leads -
leads:enrich
- Enrich lead datavoice:create
- Create voice clones - voice:read
- List voice clones -
voice:update
- Update voice settings - voice:delete
- Delete voice
clones - voice:preview
- Generate voice previewsjobs:read
- Read job data and status - jobs:update
- Modify job
messagesRead-Only Access
["users:read", "linkedin:read", "leads:read", "jobs:read"]
LinkedIn Automation
["users:read", "linkedin:schedule", "linkedin:read", "jobs:read"]
Lead Management
["users:read", "leads:read", "leads:write", "leads:enrich"]
Full Integration
["users:read", "users:write", "linkedin:schedule", "linkedin:read", "leads:read", "leads:write", "leads:enrich", "jobs:read"]
Endpoint | Permission Required |
---|---|
POST /linkedin/scheduleLinkedInAction | linkedin:schedule |
POST /linkedin/uploadProspects | linkedin:upload |
GET /leads | leads:read |
POST /leads | leads:write |
POST /enrich | leads:enrich |
GET /users/jobs | users:read |
GET /health , GET /info | None |
Environment Variables
Key Rotation
Principle of Least Privilege
leads:read
, linkedin:read
- Automation scripts: Add
linkedin:schedule
, linkedin:upload
- Full integration: Include
leads:write
, leads:enrich
Error Handling
x-api-key
header