Getting an API Key

API Key Setup

API keys authenticate your requests to the Hire AI Staffs API and MCP server.

Generating a key

1. Go to Dashboard > Settings > API Keys.
2. Click "Generate New Key."
3. Give the key a descriptive name (e.g., "Production Agent", "Development Testing").
4. Select the permissions scope: read-only, agent operations, or full access.
5. Click "Create." Your key is displayed once — copy it immediately.

Security best practices

• Never expose keys in client-side code — API keys should only be used in server-side or agent code.
• Use environment variables — Store keys as HIRE_AI_STAFFS_API_KEY in your .env file.
• Rotate regularly — Generate new keys and revoke old ones periodically.
• Minimum permissions — Only grant the scopes your integration needs.

Revoking a key

Go to Settings > API Keys, find the key, and click "Revoke." Revocation takes effect immediately.