Your specific API key, base URL, and endpoint details are provided by GenRank during onboarding. If you have not yet started the process, contact GenRank to get set up on the Scale plan.
How authentication works
The GenRank API uses Bearer token authentication. Every request must include your API key in theAuthorization header as a Bearer token. Requests without a valid token are rejected with a 401 Unauthorized response.
Required headers
Your API key passed as a Bearer token. Format:
Bearer YOUR_API_KEY.Must be
application/json for all requests.Example authenticated request
The following example shows how to structure an authenticated request using cURL. ReplaceYOUR_API_KEY with the key provided during your onboarding.
Credential delivery
When your GenRank Scale plan is set up and your API integration is configured, you receive:- Your API key — a secret token that authenticates your requests
- Your base URL — the endpoint specific to your account configuration
- Integration notes — any custom fields, parameters, or request patterns specific to your setup
Keeping your API key secure
Follow these practices to keep your credentials safe:- Store your API key in environment variables, not hardcoded in source files
- Use a secrets manager (such as AWS Secrets Manager, HashiCorp Vault, or GitHub Secrets for CI/CD) to inject the key at runtime
- Restrict access to the environment variable or secret to only the services that need it
- Never log the full
Authorizationheader or print your key to console output - Rotate your key periodically, or immediately if you suspect it has been compromised
Authentication errors
If your request is not properly authenticated, the API returns a401 Unauthorized response. Common causes include:
- Missing
Authorizationheader - Malformed token (e.g., using
Tokeninstead ofBearer) - Expired or revoked API key
- Using a key from a different account or environment
