You can manage API keys by navigating to Settings > Team > API Keys.
Overview
API keys allow you to access the Giselle API programmatically to run your apps from external applications, scripts, or services. API keys are scoped to your team, meaning all team members share access to the same set of API keys.Creating an API Key
1
Navigate to API Keys Settings
Go to Settings > Team > API Keys in the Giselle.
2
Create a New Key
Click the Create new secret key button to open the creation dialog.
3
Add a Label (Optional)
Enter a descriptive label for your API key (e.g., “Production Server”, “CI/CD Pipeline”). This helps you identify the key’s purpose later.
Labels can be up to 128 characters long.
4
Copy Your API Key
After creation, your API key will be displayed once. Copy it immediately and store it securely.
API Key Format
API keys follow the format:gsk_abc123xyz.secret_value_here
When viewing your API keys in the settings, you’ll see a redacted version showing only the first few and last few characters (e.g., gsk_abc...xyz).
Managing API Keys
Viewing API Keys
The API Keys page displays all keys for your team with the following information:- Label: The descriptive name you assigned
- Redacted Value: A shortened version of the key for identification
- Created At: When the key was created
- Last Used At: When the key was last used for an API request
Revoking API Keys
To revoke an API key:- Navigate to Settings > Team > API Keys
- Find the key you want to revoke
- Click the Revoke button
- Confirm the revocation
Using API Keys
When making requests to the Giselle API, include your API key in theAuthorization header:
Security Best Practices
Keep Keys Secret
Keep Keys Secret
Never expose API keys in client-side code, public repositories, or logs. Use environment variables or secure secret management systems.
Use Descriptive Labels
Use Descriptive Labels
Label your keys by their use case (e.g., “Production”, “Development”, “CI/CD”) to easily track and manage them.
Rotate Keys Regularly
Rotate Keys Regularly
Periodically create new keys and revoke old ones, especially if you suspect a key may have been compromised.
Limit Key Distribution
Limit Key Distribution
Only share API keys with team members and systems that genuinely need API access.
Rate Limits
API requests are rate-limited based on your team’s plan:| Plan | Requests per Minute |
|---|---|
| Free | 60 |
| Pro | 300 |
| Team | 600 |
| Enterprise | 3,000 |
429 Too Many Requests response. Rate limit information is included in response headers:
RateLimit-Limit: Maximum requests allowed per minuteRateLimit-Remaining: Remaining requests in the current windowRateLimit-Reset: Unix timestamp when the rate limit resetsRetry-After: Seconds to wait before retrying (when rate limited)
Troubleshooting
Unauthorized (401) Error
If you receive a 401 error, check that:- Your API key is correct and complete
- The key hasn’t been revoked
- The
Authorizationheader is formatted correctly:Bearer <your_api_key>
Rate Limited (429) Error
If you’re being rate limited:- Check the
Retry-Afterheader for when you can retry - Consider upgrading your plan for higher limits
- Implement exponential backoff in your application
Next Steps
- Learn how to use the Giselle SDK for easier API integration
- Explore the Playground to test your apps before integrating via API