Authentication
Every request to the Acme API needs an API key.
Send your key in the Authorization header. Rotate it when a teammate leaves.
POST/v2/api-keys/{id}/rotate
Use '/' for commands
paramstringpathrequired
Modern API documentation developers enjoy and AI can read
Import your OpenAPI spec and publish interactive API docs in minutes.
Always in sync, AI-ready, and on your own domain.
Free planĀ·10-day free trialĀ·No credit card required
GuidesAPI reference
Getting started
Acme overview
Invite your team
Connect a data source
Security & access
Set up SSO
Manage seats and roles
API keys
Create an API key
Rotate an API key
API key scopes
Audit log
Dashboards & reports
Share a dashboard
Schedule a report
Alerts
Integrations
Slack
Linear
Webhooks
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
How can we help you?
Ask AI or search our help articles to find an answer to your questions.
Search...Ask AI
Getting started
Set up your workspace, invite your team and connect your data.
8 articles
Security & access
SSO, seats, roles and API keys for your workspace.
12 articles
Dashboards & reports
Build dashboards, share reports and set alerts.
21 articles
Integrations
Connect Slack, Linear and webhooks to Acme.
9 articles
Set up SSO
Let your team sign in to Acme with your identity provider.
With SSO on, your team signs in to Acme through your identity provider. You need the Admin role and a verified domain.
1
Add your domain
- Open Settings ā Security.
- Add your company domain and copy the TXT record.
- Add the record to your DNS. Acme checks it for you.
2
Connect your identity provider
Paste the metadata URL from Okta, Microsoft Entra ID or Google Workspace. Acme reads the rest.
3
Turn on SSO for your team
Turn on SSO. Teammates sign in with SSO the next time they open Acme.
Still need help? Ask the team
Rotate an API key
Swap in a new key without downtime, then retire the old one.
Rotate a key when a teammate leaves or when a key may have leaked. The old key keeps working for 24 hours, so your apps never stop.
1
Rotate the key
- Open Settings ā API keys.
- Open the key and select
Rotate. - Copy the new key. It starts with
ak_live_.
Update the key in your apps within 24 hours. After that, requests with the old key fail with
401.
2
Update your apps
Replace the old key in every app and server that calls the Acme API. Then send one test request with the new key.
3
Revoke the old key
Done early? Open the old key and select Revoke to stop it at once.
Still need help? Ask the team
Rotate keys without downtime
Rotate an API key from your code. The old key keeps working for 24 hours.
An API key has full access to your workspace. Keep it on your server, never in browser code or in git.
1
Rotate the key
Send the key's ID. The response holds the new key, and the old one stays valid for 24 hours.
POST/v2/api-keys/{id}/rotate
curl --request POST \ --url https://api.acme.com/v2/api-keys/$KEY_ID/rotate \ --header 'Authorization: Bearer $ACME_API_KEY'
2
Deploy the new key
Store the new key in your secrets manager and deploy. Then send one test request with it.
3
Revoke the old key
When every app uses the new key, call DELETE /v2/api-keys/{id} on the old one.
Still need help? Ask the team
API 2025-11-01 is deprecated. See this page in API 2026-09-01
API keys
Rotate an API key
Creates a new secret for the key. The old secret keeps working for 24 hours.
POST
Try it/v2/api-keys/{id}/rotate
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
idstringrequired
The ID of the API key to rotate.
Search or ask AIā¦
Ask AIAsk anything about Acme
Suggested
Acme overviewGetting started
Set up SSOSecurity & access
Share a dashboardDashboards & reports
SlackIntegrations
Suggested
GETList API keys/v2/api-keys
POSTCreate an event/v2/events
Trending requests
Rotate API keys on a scheduleFeature requests14
Export dashboards as PDFFeature requests9
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
Create an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
API key scopesSecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate keys without downtimeAPI guides
Rotate an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
āµopenā„āµask AIesc
How long does the old key keep working?
Searching the docsā¦
The old key keeps working for 24 hours after you rotate it. Use that time to put the new key in your apps.
After 24 hours, requests with the old key fail with 401. To stop it sooner, open the key in Settings ā API keys and select Revoke.
Sources
- Rotate an API keyAPI keys
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
How do I rotate an API key without downtime?
Searching the docsā¦
Rotate the key, then move your apps to the new one. The old key keeps working for 24 hours, so nothing breaks while you deploy.
Call POST /v2/api-keys/{id}/rotate or select Rotate in Settings ā API keys. When every app uses the new key, revoke the old one.
Sources
- Rotate keys without downtimeAPI guides
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
POSTRotate an API key
POST
Send/v2/api-keys/{id}/rotate
Rotate an API key
Creates a new secret for the key. The old secret keeps working for 24 hours.
Authorization
Authorizationstring<bearer>required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearerak_live_2Hc9vQ7xL1mN
Path
idstringrequired
The ID of the API key to rotate.
enter id
Rotate an API key
Python
import requests url = "https://api.acme.com/v2/api-keys/{id}/rotate" headers = {"Authorization": "Bearer <token>"} response = requests.post(url, headers=headers) print(response.text)
import requests url = "https://api.acme.com/v2/api-keys/key_8f2c/rotate" headers = {"Authorization": "Bearer <token>"} response = requests.post(url, headers=headers) print(response.text)
Send a request to see the response here.
Sending request
200 OK184 ms212 B
BodyHeaders (6)
{
"id": "key_8f2c",
"name": "Production server",
"secret": "ak_live_Xc81Rt0aPq5v",
"createdAt": "2026-10-08T09:41:12Z",
"oldKeyExpiresAt": "2026-10-09T09:41:12Z"
}For developers
An API referencedevelopers enjoy
GuidesAPI reference
Getting started
Acme overview
Invite your team
Connect a data source
Security & access
Set up SSO
Manage seats and roles
API keys
Create an API key
Rotate an API key
API key scopes
Audit log
Dashboards & reports
Share a dashboard
Schedule a report
Alerts
Integrations
Slack
Linear
Webhooks
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
How can we help you?
Ask AI or search our help articles to find an answer to your questions.
Search...Ask AI
Getting started
Set up your workspace, invite your team and connect your data.
8 articles
Security & access
SSO, seats, roles and API keys for your workspace.
12 articles
Dashboards & reports
Build dashboards, share reports and set alerts.
21 articles
Integrations
Connect Slack, Linear and webhooks to Acme.
9 articles
API keys
Create, rotate and scope keys for the API.
7 articles
Data sources
Connect a database, a warehouse or a CSV file.
14 articles
Sharing & embeds
Share dashboards by link or embed them.
6 articles
Alerts
Get a message in Slack when a metric moves.
5 articles
Import & export
Move data in and out of Acme with CSV files.
8 articles
Developers
Build on Acme with the REST API and SDKs.
18 articles
Workspaces
Organize teams, projects and environments.
4 articles
Troubleshooting
Fix sync errors and slow dashboards.
11 articles
Set up SSO
Let your team sign in to Acme with your identity provider.
With SSO on, your team signs in to Acme through your identity provider. You need the Admin role and a verified domain.
1
Add your domain
- Open Settings ā Security.
- Add your company domain and copy the TXT record.
- Add the record to your DNS. Acme checks it for you.
2
Connect your identity provider
Paste the metadata URL from Okta, Microsoft Entra ID or Google Workspace. Acme reads the rest.
3
Turn on SSO for your team
Turn on SSO. Teammates sign in with SSO the next time they open Acme.
Still need help? Ask the team
Rotate an API key
Swap in a new key without downtime, then retire the old one.
Rotate a key when a teammate leaves or when a key may have leaked. The old key keeps working for 24 hours, so your apps never stop.
1
Rotate the key
- Open Settings ā API keys.
- Open the key and select
Rotate. - Copy the new key. It starts with
ak_live_.
Update the key in your apps within 24 hours. After that, requests with the old key fail with
401.
2
Update your apps
Replace the old key in every app and server that calls the Acme API. Then send one test request with the new key.
3
Revoke the old key
Done early? Open the old key and select Revoke to stop it at once.
Still need help? Ask the team
Rotate keys without downtime
Rotate an API key from your code. The old key keeps working for 24 hours.
An API key has full access to your workspace. Keep it on your server, never in browser code or in git.
1
Rotate the key
Send the key's ID. The response holds the new key, and the old one stays valid for 24 hours.
POST/v2/api-keys/{id}/rotate
curl --request POST \ --url https://api.acme.com/v2/api-keys/$KEY_ID/rotate \ --header 'Authorization: Bearer $ACME_API_KEY'
2
Deploy the new key
Store the new key in your secrets manager and deploy. Then send one test request with it.
3
Revoke the old key
When every app uses the new key, call DELETE /v2/api-keys/{id} on the old one.
Still need help? Ask the team
API 2025-11-01 is deprecated. See this page in API 2026-09-01
API keys
Rotate an API key
Creates a new secret for the key. The old secret keeps working for 24 hours.
POST
Try it/v2/api-keys/{id}/rotate
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
idstringrequired
The ID of the API key to rotate.
Search or ask AIā¦
Ask AIAsk anything about Acme
Suggested
Acme overviewGetting started
Set up SSOSecurity & access
Share a dashboardDashboards & reports
SlackIntegrations
Suggested
GETList API keys/v2/api-keys
POSTCreate an event/v2/events
Trending requests
Rotate API keys on a scheduleFeature requests14
Export dashboards as PDFFeature requests9
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
Create an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
API key scopesSecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate keys without downtimeAPI guides
Rotate an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
āµopenā„āµask AIesc
How long does the old key keep working?
Searching the docsā¦
The old key keeps working for 24 hours after you rotate it. Use that time to put the new key in your apps.
After 24 hours, requests with the old key fail with 401. To stop it sooner, open the key in Settings ā API keys and select Revoke.
Sources
- Rotate an API keyAPI keys
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
How do I rotate an API key without downtime?
Searching the docsā¦
Rotate the key, then move your apps to the new one. The old key keeps working for 24 hours, so nothing breaks while you deploy.
Call POST /v2/api-keys/{id}/rotate or select Rotate in Settings ā API keys. When every app uses the new key, revoke the old one.
Sources
- Rotate keys without downtimeAPI guides
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
How do I rotate an API key with the API?
Searching the docsā¦
Call POST /v2/api-keys/{id}/rotate with the ID of the key. The response holds the new secret.
The old secret keeps working for 24 hours, so you can move your apps to the new one without downtime.
Sources
- POSTRotate an API key/v2/api-keys/{id}/rotate
- Rotate keys without downtimeAPI guides
Back to results
GuidesAPI reference
Getting started
Acme overview
Invite your team
Connect a data source
Security & access
Set up SSO
Manage seats and roles
API keys
Create an API key
Rotate an API key
API key scopes
Audit log
Dashboards & reports
Share a dashboard
Schedule a report
Alerts
Integrations
Slack
Linear
Webhooks
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
How can we help you?
Ask AI or search our help articles to find an answer to your questions.
Search...Ask AI
Getting started
Set up your workspace, invite your team and connect your data.
8 articles
Security & access
SSO, seats, roles and API keys for your workspace.
12 articles
Dashboards & reports
Build dashboards, share reports and set alerts.
21 articles
Integrations
Connect Slack, Linear and webhooks to Acme.
9 articles
API keys
Create, rotate and scope keys for the API.
7 articles
Data sources
Connect a database, a warehouse or a CSV file.
14 articles
Sharing & embeds
Share dashboards by link or embed them.
6 articles
Alerts
Get a message in Slack when a metric moves.
5 articles
Import & export
Move data in and out of Acme with CSV files.
8 articles
Developers
Build on Acme with the REST API and SDKs.
18 articles
Workspaces
Organize teams, projects and environments.
4 articles
Troubleshooting
Fix sync errors and slow dashboards.
11 articles
Set up SSO
Let your team sign in to Acme with your identity provider.
With SSO on, your team signs in to Acme through your identity provider. You need the Admin role and a verified domain.
1
Add your domain
- Open Settings ā Security.
- Add your company domain and copy the TXT record.
- Add the record to your DNS. Acme checks it for you.
2
Connect your identity provider
Paste the metadata URL from Okta, Microsoft Entra ID or Google Workspace. Acme reads the rest.
3
Turn on SSO for your team
Turn on SSO. Teammates sign in with SSO the next time they open Acme.
Still need help? Ask the team
Rotate an API key
Swap in a new key without downtime, then retire the old one.
Rotate a key when a teammate leaves or when a key may have leaked. The old key keeps working for 24 hours, so your apps never stop.
1
Rotate the key
- Open Settings ā API keys.
- Open the key and select
Rotate. - Copy the new key. It starts with
ak_live_.
Update the key in your apps within 24 hours. After that, requests with the old key fail with
401.
2
Update your apps
Replace the old key in every app and server that calls the Acme API. Then send one test request with the new key.
3
Revoke the old key
Done early? Open the old key and select Revoke to stop it at once.
Still need help? Ask the team
Rotate keys without downtime
Rotate an API key from your code. The old key keeps working for 24 hours.
An API key has full access to your workspace. Keep it on your server, never in browser code or in git.
1
Rotate the key
Send the key's ID. The response holds the new key, and the old one stays valid for 24 hours.
POST/v2/api-keys/{id}/rotate
curl --request POST \ --url https://api.acme.com/v2/api-keys/$KEY_ID/rotate \ --header 'Authorization: Bearer $ACME_API_KEY'
2
Deploy the new key
Store the new key in your secrets manager and deploy. Then send one test request with it.
3
Revoke the old key
When every app uses the new key, call DELETE /v2/api-keys/{id} on the old one.
Still need help? Ask the team
API 2025-11-01 is deprecated. See this page in API 2026-09-01
API keys
Rotate an API key
Creates a new secret for the key. The old secret keeps working for 24 hours.
POST
Try it/v2/api-keys/{id}/rotate
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
idstringrequired
The ID of the API key to rotate.
API reference
Acme API 2026-09-01
Read and change your Acme data from your own code.
Base URL
All requests use this base URL:
https://api.acme.comAuthentication
Authorizationstringheaderbearer
Send your API key as a bearer token: Bearer <token>.
curl --request GET \ --url https://api.acme.com/v2/api-keys \ --header 'Authorization: Bearer <token>'
Search or ask AIā¦
Ask AIAsk anything about Acme
Suggested
Acme overviewGetting started
Set up SSOSecurity & access
Share a dashboardDashboards & reports
SlackIntegrations
Suggested
GETList API keys/v2/api-keys
POSTCreate an event/v2/events
Trending requests
Rotate API keys on a scheduleFeature requests14
Export dashboards as PDFFeature requests9
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
Create an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
API key scopesSecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate keys without downtimeAPI guides
Rotate an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
āµopenā„āµask AIesc
How long does the old key keep working?
Searching the docsā¦
The old key keeps working for 24 hours after you rotate it. Use that time to put the new key in your apps.
After 24 hours, requests with the old key fail with 401. To stop it sooner, open the key in Settings ā API keys and select Revoke.
Sources
- Rotate an API keyAPI keys
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
How do I rotate an API key without downtime?
Searching the docsā¦
Rotate the key, then move your apps to the new one. The old key keeps working for 24 hours, so nothing breaks while you deploy.
Call POST /v2/api-keys/{id}/rotate or select Rotate in Settings ā API keys. When every app uses the new key, revoke the old one.
Sources
- Rotate keys without downtimeAPI guides
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
GuidesAPI reference
Getting started
Acme overview
Invite your team
Connect a data source
Security & access
Set up SSO
Manage seats and roles
API keys
Create an API key
Rotate an API key
API key scopes
Audit log
Dashboards & reports
Share a dashboard
Schedule a report
Alerts
Integrations
Slack
Linear
Webhooks
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
How can we help you?
Ask AI or search our help articles to find an answer to your questions.
Search...Ask AI
Getting started
Set up your workspace, invite your team and connect your data.
8 articles
Security & access
SSO, seats, roles and API keys for your workspace.
12 articles
Dashboards & reports
Build dashboards, share reports and set alerts.
21 articles
Integrations
Connect Slack, Linear and webhooks to Acme.
9 articles
API keys
Create, rotate and scope keys for the API.
7 articles
Data sources
Connect a database, a warehouse or a CSV file.
14 articles
Sharing & embeds
Share dashboards by link or embed them.
6 articles
Alerts
Get a message in Slack when a metric moves.
5 articles
Import & export
Move data in and out of Acme with CSV files.
8 articles
Developers
Build on Acme with the REST API and SDKs.
18 articles
Workspaces
Organize teams, projects and environments.
4 articles
Troubleshooting
Fix sync errors and slow dashboards.
11 articles
Set up SSO
Let your team sign in to Acme with your identity provider.
With SSO on, your team signs in to Acme through your identity provider. You need the Admin role and a verified domain.
1
Add your domain
- Open Settings ā Security.
- Add your company domain and copy the TXT record.
- Add the record to your DNS. Acme checks it for you.
2
Connect your identity provider
Paste the metadata URL from Okta, Microsoft Entra ID or Google Workspace. Acme reads the rest.
3
Turn on SSO for your team
Turn on SSO. Teammates sign in with SSO the next time they open Acme.
Still need help? Ask the team
Rotate an API key
Swap in a new key without downtime, then retire the old one.
Rotate a key when a teammate leaves or when a key may have leaked. The old key keeps working for 24 hours, so your apps never stop.
1
Rotate the key
- Open Settings ā API keys.
- Open the key and select
Rotate. - Copy the new key. It starts with
ak_live_.
Update the key in your apps within 24 hours. After that, requests with the old key fail with
401.
2
Update your apps
Replace the old key in every app and server that calls the Acme API. Then send one test request with the new key.
3
Revoke the old key
Done early? Open the old key and select Revoke to stop it at once.
Still need help? Ask the team
Rotate keys without downtime
Rotate an API key from your code. The old key keeps working for 24 hours.
An API key has full access to your workspace. Keep it on your server, never in browser code or in git.
1
Rotate the key
Send the key's ID. The response holds the new key, and the old one stays valid for 24 hours.
POST/v2/api-keys/{id}/rotate
curl --request POST \ --url https://api.acme.com/v2/api-keys/$KEY_ID/rotate \ --header 'Authorization: Bearer $ACME_API_KEY'
2
Deploy the new key
Store the new key in your secrets manager and deploy. Then send one test request with it.
3
Revoke the old key
When every app uses the new key, call DELETE /v2/api-keys/{id} on the old one.
Still need help? Ask the team
API 2025-11-01 is deprecated. See this page in API 2026-09-01
API keys
Rotate an API key
Creates a new secret for the key. The old secret keeps working for 24 hours.
POST
Try it/v2/api-keys/{id}/rotate
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
idstringrequired
The ID of the API key to rotate.
Search or ask AIā¦
Ask AIAsk anything about Acme
Suggested
Acme overviewGetting started
Set up SSOSecurity & access
Share a dashboardDashboards & reports
SlackIntegrations
Suggested
GETList API keys/v2/api-keys
POSTCreate an event/v2/events
Trending requests
Rotate API keys on a scheduleFeature requests14
Export dashboards as PDFFeature requests9
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
Create an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
API key scopesSecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate keys without downtimeAPI guides
Rotate an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
āµopenā„āµask AIesc
How long does the old key keep working?
Searching the docsā¦
The old key keeps working for 24 hours after you rotate it. Use that time to put the new key in your apps.
After 24 hours, requests with the old key fail with 401. To stop it sooner, open the key in Settings ā API keys and select Revoke.
Sources
- Rotate an API keyAPI keys
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
How do I rotate an API key without downtime?
Searching the docsā¦
Rotate the key, then move your apps to the new one. The old key keeps working for 24 hours, so nothing breaks while you deploy.
Call POST /v2/api-keys/{id}/rotate or select Rotate in Settings ā API keys. When every app uses the new key, revoke the old one.
Sources
- Rotate keys without downtimeAPI guides
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
POSTRotate an API key
POST
Send/v2/api-keys/{id}/rotate
Rotate an API key
Creates a new secret for the key. The old secret keeps working for 24 hours.
Authorization
Authorizationstring<bearer>required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearerak_live_2Hc9vQ7xL1mN
Path
idstringrequired
The ID of the API key to rotate.
enter id
Rotate an API key
Python
import requests url = "https://api.acme.com/v2/api-keys/{id}/rotate" headers = {"Authorization": "Bearer <token>"} response = requests.post(url, headers=headers) print(response.text)
import requests url = "https://api.acme.com/v2/api-keys/key_8f2c/rotate" headers = {"Authorization": "Bearer <token>"} response = requests.post(url, headers=headers) print(response.text)
Send a request to see the response here.
Sending request
200 OK184 ms212 B
BodyHeaders (6)
{
"id": "key_8f2c",
"name": "Production server",
"secret": "ak_live_Xc81Rt0aPq5v",
"createdAt": "2026-10-08T09:41:12Z",
"oldKeyExpiresAt": "2026-10-09T09:41:12Z"
}AcmeOverview
Brightline Ā· Last 30 days
Active users482
Sessions1,960
Avg. time6m 12s
Weekly active users
Fibi
Hi, Dana! šHow can we help you today?
- Invite your team
- Set up SSO
- Connect Slack
How do I rotate an API key with the API?
Call this endpoint with the keyās ID:
POST /v2/api-keys/{id}/rotate 1
- Copy the new
secretit returns. - Update your apps within 24 hours.
FibiĀ·Now
Thinking...
Ask anything
Instant answers right in the search bar to help developers find what they need - fast.
Put quickstarts and how-to guides in the same sidebar as your API reference.
Test every endpoint right from the docs and copy ready-to-use code in 9 languages.
Fibi answers developer questions across your support channels, alongside the rest of your support.
āThe built-in AI answers and support for multiple languages in a single docs site is very helpful. The interface feels intuitive and is easy-to-use.ā
Mustafa KurtHead of Product, Booking ExpertsFor AI
Optimized for LLMsout of the box
ClaudeChatGPTCursorhelp.acme.com/llms.txt
# Acme Help Center
> Guides and API reference for Acme.
## API guides
- [Authentication](https://help.acme.com/articles/2817465-authentication.md)
- [Rotate keys without downtime](https://help.acme.com/articles/2817503-rotate-keys-without-downtime.md)
## API reference: API keys
- [Create an API key](https://help.acme.com/api-reference/api-keys/create-an-api-key.md)
- [Rotate an API key](https://help.acme.com/api-reference/api-keys/rotate-an-api-key.md)
## API reference: Events
- [Send an event](https://help.acme.com/api-reference/events/send-an-event.md)
ClaudeChatGPTCursorhelp.acme.com/llms.txt
# Acme Help Center
> Guides and API reference for Acme.
## API guides
- [Authentication](https://help.acme.com/articles/2817465-authentication.md)
- [Rotate keys without downtime](https://help.acme.com/articles/2817503-rotate-keys-without-downtime.md)
## API reference: API keys
- [Create an API key](https://help.acme.com/api-reference/api-keys/create-an-api-key.md)
- [Rotate an API key](https://help.acme.com/api-reference/api-keys/rotate-an-api-key.md)
## API reference: Events
- [Send an event](https://help.acme.com/api-reference/events/send-an-event.md)
ClaudeChatGPTCursorAcme API reference
Featurebase MCP server
Acme APIDraft to review
AuthenticationDraft
Rotate keys without downtimeLiveUnpublished changes
POSTCreate an API keyLive
GETList API keysLive
PaginationLive
ClaudeChatGPTCursorAcme API reference
Featurebase MCP server
Acme APIDraft to review
AuthenticationDraft
Rotate keys without downtimeLiveUnpublished changes
POSTCreate an API keyLive
GETList API keysLive
PaginationLive
GuidesAPI reference
Getting started
Acme overview
Invite your team
Connect a data source
Security & access
Set up SSO
Manage seats and roles
API keys
Create an API key
Rotate an API key
API key scopes
Audit log
Dashboards & reports
Share a dashboard
Schedule a report
Alerts
Integrations
Slack
Linear
Webhooks
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
How can we help you?
Ask AI or search our help articles to find an answer to your questions.
Search...Ask AI
Getting started
Set up your workspace, invite your team and connect your data.
8 articles
Security & access
SSO, seats, roles and API keys for your workspace.
12 articles
Dashboards & reports
Build dashboards, share reports and set alerts.
21 articles
Integrations
Connect Slack, Linear and webhooks to Acme.
9 articles
API keys
Create, rotate and scope keys for the API.
7 articles
Data sources
Connect a database, a warehouse or a CSV file.
14 articles
Sharing & embeds
Share dashboards by link or embed them.
6 articles
Alerts
Get a message in Slack when a metric moves.
5 articles
Import & export
Move data in and out of Acme with CSV files.
8 articles
Developers
Build on Acme with the REST API and SDKs.
18 articles
Workspaces
Organize teams, projects and environments.
4 articles
Troubleshooting
Fix sync errors and slow dashboards.
11 articles
Set up SSO
Let your team sign in to Acme with your identity provider.
With SSO on, your team signs in to Acme through your identity provider. You need the Admin role and a verified domain.
1
Add your domain
- Open Settings ā Security.
- Add your company domain and copy the TXT record.
- Add the record to your DNS. Acme checks it for you.
2
Connect your identity provider
Paste the metadata URL from Okta, Microsoft Entra ID or Google Workspace. Acme reads the rest.
3
Turn on SSO for your team
Turn on SSO. Teammates sign in with SSO the next time they open Acme.
Still need help? Ask the team
Rotate an API key
Swap in a new key without downtime, then retire the old one.
Rotate a key when a teammate leaves or when a key may have leaked. The old key keeps working for 24 hours, so your apps never stop.
1
Rotate the key
- Open Settings ā API keys.
- Open the key and select
Rotate. - Copy the new key. It starts with
ak_live_.
Update the key in your apps within 24 hours. After that, requests with the old key fail with
401.
2
Update your apps
Replace the old key in every app and server that calls the Acme API. Then send one test request with the new key.
3
Revoke the old key
Done early? Open the old key and select Revoke to stop it at once.
Still need help? Ask the team
Rotate keys without downtime
Rotate an API key from your code. The old key keeps working for 24 hours.
An API key has full access to your workspace. Keep it on your server, never in browser code or in git.
1
Rotate the key
Send the key's ID. The response holds the new key, and the old one stays valid for 24 hours.
POST/v2/api-keys/{id}/rotate
curl --request POST \ --url https://api.acme.com/v2/api-keys/$KEY_ID/rotate \ --header 'Authorization: Bearer $ACME_API_KEY'
2
Deploy the new key
Store the new key in your secrets manager and deploy. Then send one test request with it.
3
Revoke the old key
When every app uses the new key, call DELETE /v2/api-keys/{id} on the old one.
Still need help? Ask the team
API 2025-11-01 is deprecated. See this page in API 2026-09-01
API keys
Rotate an API key
Copy as MarkdownCopy this page to paste into an AI chat.
View as MarkdownOpen this page as Markdown in a new tab.
Open in ChatGPTAsk ChatGPT about this page.
Open in ClaudeAsk Claude about this page.
Copy page linkCopy a link to share this page.
Download specSave the OpenAPI file for this API version.
Creates a new secret for the key. The old secret keeps working for 24 hours.
POST
Try it/v2/api-keys/{id}/rotate
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
idstringrequired
The ID of the API key to rotate.
Search or ask AIā¦
Ask AIAsk anything about Acme
Suggested
Acme overviewGetting started
Set up SSOSecurity & access
Share a dashboardDashboards & reports
SlackIntegrations
Suggested
GETList API keys/v2/api-keys
POSTCreate an event/v2/events
Trending requests
Rotate API keys on a scheduleFeature requests14
Export dashboards as PDFFeature requests9
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
Create an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
API key scopesSecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate keys without downtimeAPI guides
Rotate an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
āµopenā„āµask AIesc
How long does the old key keep working?
Searching the docsā¦
The old key keeps working for 24 hours after you rotate it. Use that time to put the new key in your apps.
After 24 hours, requests with the old key fail with 401. To stop it sooner, open the key in Settings ā API keys and select Revoke.
Sources
- Rotate an API keyAPI keys
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
How do I rotate an API key without downtime?
Searching the docsā¦
Rotate the key, then move your apps to the new one. The old key keeps working for 24 hours, so nothing breaks while you deploy.
Call POST /v2/api-keys/{id}/rotate or select Rotate in Settings ā API keys. When every app uses the new key, revoke the old one.
Sources
- Rotate keys without downtimeAPI guides
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
help.acme.com/api-reference/api-keys/rotate-an-api-key.md
# Rotate an API key`POST /v2/api-keys/{id}/rotate`Creates a new secret for the key. The old secret keeps working for 24 hours.## Authorization- bearerAuth (`Authorization` header, bearer)## Path parameters- `id` (string, required): The ID of the API key to rotate.## Responses### 200: The rotated key- `id` (string): The ID of the key.- `name` (string): The name of the key.- `secret` (string): The new secret. It starts with `ak_live_`.- `oldKeyExpiresAt` (string (date-time)): When the old secret stops working.Example:```json{"id": "key_8f2c","name": "Production server","secret": "ak_live_7Qm2ā¦","oldKeyExpiresAt": "2026-10-09T09:41:00Z"}```
ChatGPT
How do I rotate an Acme API key with the API?
Searching the web...Reading help.acme.com
According to Acmeās API reference, call:
POST /v2/api-keys/{id}/rotateIt returns a new secret. The old one keeps working for 24 hours. 1
Sources
Rotate an API keyhelp.acme.com/api-reference/api-keys/rotate-an-api-key1
Ask a question
Every guide and endpoint is listed in your llms.txt, so AI tools find their way.
Write and update your API docs from Claude, ChatGPT, or Cursor through our MCP.
Copy any page as Markdown, or open it in ChatGPT or Claude in one click.
Built to be found and cited by ChatGPT, Claude and other LLMs, with nothing to set up.
Editing
Effortlesslyup to date
API reference
Each spec is one API version.
Acme APIv2Default42 pages, checked 2 h ago
Acme APIv1Deprecated38 pages, uploaded 12 Mar
Tab name
API reference
Start page
Acme APIAutomaticBuilt from your spec. Edit to turn it into an article.ViewEdit
PagesAdd section
Getting started
AuthenticationPaginationRate limits
API reference
Acme API
v2, default version, from api.acme.com
EndpointsSourceSettingsHistory
Hide new endpoints until I pick themNew endpoints stay off until you tick them in the review.
Search endpointsSelect all42/43
Webhooks2/3
GETList webhooks/v2/webhooks
POSTCreate a webhook/v2/webhooks
POSTSend a test event/v2/webhooks/{id}/test
API keys4/4
GETList API keys/v2/api-keys
POSTCreate an API key/v2/api-keys
POSTRotate an API key/v2/api-keys/{id}/rotate
DELRevoke an API key/v2/api-keys/{id}
Posts3/3
GETList posts/v2/posts
POSTCreate a post/v2/posts
GETGet a post/v2/posts/{id}
DiscardSave 43 pages
Endpoint pages saved
Acme Help CenterAuthentication
Edited nowPublish
API keys
Rotate an API key
Swap in a new key without downtime, then retire the old one.
1
Rotate the key
Open Settings ā API keys, open the key and select Rotate.
Fibi is writingā¦Added automaticallyĀ· from 3 conversations
Webhooks keep working. Rotating a key doesnāt change your webhook signing secret, so thereās nothing to update.
2
Update your apps
Replace the old key in every app and server that calls the Acme API.
3
Revoke the old key
Done early? Open the old key and select Revoke to stop it at once.
Dana Kim Ā· Brightline
Will rotating our key break webhooks?
Leo Grant Ā· Tidewell
Do webhooks work after a key rotation?
Maya Chen Ā· Fernway
New API key. Do I update webhooks?
API reference
Acme APIDraft
v2, default version
Last push 2 h ago, revision 6Last push just now, revision 7, draft to reviewLast push just now, revision 7
Not published. 1 endpoint added, 1 changed, 1 breaking. Readers see revision 6 until you publish.PreviewDiscardPublish with breaking changes
EndpointsSourceSettingsHistory
Changes to review
Changed 1Pages update
GET
/v2/api-keysBreaking-query param status added (required)breakingAdded 1New pages
POST
/v2/api-keys/{id}/rotatePublish pagePublished endpoints
API keys3/34/4
GETList API keys/v2/api-keys
POSTCreate an API key/v2/api-keys
POSTRotate an API key/v2/api-keys/{id}/rotate
DELRevoke an API key/v2/api-keys/{id}
Posts6/6
Webhooks3/3
Users5/5
Companies4/4
Changes published
help.acme.com/api-reference/api-keys/ā¦/list-api-keys?apiPreview=draft
Draft preview. Only admins see this.Back to editor
AcmeGuidesAPI reference
API v2
API keys
GETList API keysPOSTCreate an API keyPOSTRotate an API keyDELRevoke an API keyPosts
GETList postsPOSTCreate a postAPI keys
List API keys
Returns the API keys of your workspace, newest first.
GET/v2/api-keysTry it
Query Parameters
statusstringrequired
Only keys with this status: active or revoked.
limitinteger
How many keys to return, up to 100.
Changes published
Run your API docs, versions and settings from one clean dashboard.
Add endpoints, parameters and request examples to any guide.
AI finds missing and outdated answers and updates your guides automatically.
Link your spec or push it from CI. Review the changes, then publish.
āFeaturebase is an impressive way to document software and keep customers engaged. An amazing product from an awesome team.ā
Michelle RatcliffeUX Docs Writer, The Despatch CompanyEnterprise
Enterprise-readySecure by default
Custom domain and branding
Serve your API docs from your own domain, with your logo, colors, fonts and dark mode.
Acmedocs.acme.comLogoColorsAaFontsThemeVersions
Release new API versions and keep the old ones live. Developers switch in one click.
API v2v2Latestv1DeprecatedPOSTCreate a post/v2/poststitlestringrequiredboardIdstringAccess controls
Restrict docs to your team or specific customers.
2 Custom access rulesEnterprise customersBeta testersTeam membersDraft history
Every change is saved. Compare drafts and roll back.
Version historyMMaya Lee4:12 PMLiveTTom Berg11:03 AMComparingAAPI9:40 AMCustom admin roles
Choose who can edit the docs, manage the API or publish.
Manage Docs writer roleManage Help CenterManage APIManage BillingSingle Sign-On
Your team signs in through your own identity provider.
Sign in with SSOmaya@acme.comContinue
Help Center
Explore Help CenterYour Help Center next to your API docs
GuidesAPI reference
Getting started
Acme overview
Invite your team
Connect a data source
Security & access
Set up SSO
Manage seats and roles
API keys
Create an API key
Rotate an API key
API key scopes
Audit log
Dashboards & reports
Share a dashboard
Schedule a report
Alerts
Integrations
Slack
Linear
Webhooks
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
API 2026-09-01
Acme API
API guides
Authentication
Rotate keys without downtime
Pagination
API keys
GETList API keys
POSTCreate an API key
POSTRotate an API key
Analytics
Events
Dashboards
Reports
How can we help you?
Ask AI or search our help articles to find an answer to your questions.
Search...Ask AI
Getting started
Set up your workspace, invite your team and connect your data.
8 articles
Security & access
SSO, seats, roles and API keys for your workspace.
12 articles
Dashboards & reports
Build dashboards, share reports and set alerts.
21 articles
Integrations
Connect Slack, Linear and webhooks to Acme.
9 articles
API keys
Create, rotate and scope keys for the API.
7 articles
Data sources
Connect a database, a warehouse or a CSV file.
14 articles
Sharing & embeds
Share dashboards by link or embed them.
6 articles
Alerts
Get a message in Slack when a metric moves.
5 articles
Import & export
Move data in and out of Acme with CSV files.
8 articles
Developers
Build on Acme with the REST API and SDKs.
18 articles
Workspaces
Organize teams, projects and environments.
4 articles
Troubleshooting
Fix sync errors and slow dashboards.
11 articles
Set up SSO
Let your team sign in to Acme with your identity provider.
With SSO on, your team signs in to Acme through your identity provider. You need the Admin role and a verified domain.
1
Add your domain
- Open Settings ā Security.
- Add your company domain and copy the TXT record.
- Add the record to your DNS. Acme checks it for you.
2
Connect your identity provider
Paste the metadata URL from Okta, Microsoft Entra ID or Google Workspace. Acme reads the rest.
3
Turn on SSO for your team
Turn on SSO. Teammates sign in with SSO the next time they open Acme.
Still need help? Ask the team
Rotate an API key
Swap in a new key without downtime, then retire the old one.
Rotate a key when a teammate leaves or when a key may have leaked. The old key keeps working for 24 hours, so your apps never stop.
1
Rotate the key
- Open Settings ā API keys.
- Open the key and select
Rotate. - Copy the new key. It starts with
ak_live_.
Update the key in your apps within 24 hours. After that, requests with the old key fail with
401.
2
Update your apps
Replace the old key in every app and server that calls the Acme API. Then send one test request with the new key.
3
Revoke the old key
Done early? Open the old key and select Revoke to stop it at once.
Still need help? Ask the team
Rotate keys without downtime
Rotate an API key from your code. The old key keeps working for 24 hours.
An API key has full access to your workspace. Keep it on your server, never in browser code or in git.
1
Rotate the key
Send the key's ID. The response holds the new key, and the old one stays valid for 24 hours.
POST/v2/api-keys/{id}/rotate
curl --request POST \ --url https://api.acme.com/v2/api-keys/$KEY_ID/rotate \ --header 'Authorization: Bearer $ACME_API_KEY'
2
Deploy the new key
Store the new key in your secrets manager and deploy. Then send one test request with it.
3
Revoke the old key
When every app uses the new key, call DELETE /v2/api-keys/{id} on the old one.
Still need help? Ask the team
API 2025-11-01 is deprecated. See this page in API 2026-09-01
API keys
Rotate an API key
Creates a new secret for the key. The old secret keeps working for 24 hours.
POST
Try it/v2/api-keys/{id}/rotate
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
idstringrequired
The ID of the API key to rotate.
Search or ask AIā¦
Ask AIAsk anything about Acme
Suggested
Acme overviewGetting started
Set up SSOSecurity & access
Share a dashboardDashboards & reports
SlackIntegrations
Suggested
GETList API keys/v2/api-keys
POSTCreate an event/v2/events
Trending requests
Rotate API keys on a scheduleFeature requests14
Export dashboards as PDFFeature requests9
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
Create an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate an API keySecurity & accessAPI keys
API key scopesSecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
Ask AIā„āµ
Articles2
Rotate keys without downtimeAPI guides
Rotate an API keySecurity & accessAPI keys
API reference1
POSTRotate an API key/v2/api-keys/{id}/rotate
Requests1
Rotate API keys on a scheduleFeature requests14
Updates
No matching updates
āµopenā„āµask AIesc
How long does the old key keep working?
Searching the docsā¦
The old key keeps working for 24 hours after you rotate it. Use that time to put the new key in your apps.
After 24 hours, requests with the old key fail with 401. To stop it sooner, open the key in Settings ā API keys and select Revoke.
Sources
- Rotate an API keyAPI keys
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
How do I rotate an API key without downtime?
Searching the docsā¦
Rotate the key, then move your apps to the new one. The old key keeps working for 24 hours, so nothing breaks while you deploy.
Call POST /v2/api-keys/{id}/rotate or select Rotate in Settings ā API keys. When every app uses the new key, revoke the old one.
Sources
- Rotate keys without downtimeAPI guides
- POSTRotate an API key/v2/api-keys/{id}/rotate
Back to results
Built for support at scale. Ready for your next stage of growth.
- Customer issues
- 30M+
- Countries
- 186+
- Customers
- 1,600+
- Uptime
- >99.99%
Your customer data, protected
- SOC 2 Type II
- GDPR
- CCPA
Trusted by fast-growing software companies.
Read customer storiesāMy entire support documentation and FAQ for Photo AI is now all on @FeaturebaseHQ. (Iām unaffiliated to Featurebase, I just like the product).ā
Pieter LevelsFounderāFeaturebase has the perfect mix of features. Branding, custom domain, and integrations took minutes. Exactly what I was looking for.ā
Scott SagerFounderSimple, transparent pricing.No sales calls. Start today.
Free
For individuals to get started
$0forever
Get started for free
Includes
- API reference from OpenAPI
- Unlimited readers
- Interactive API playground
- Code samples in 9 languages
- Import from file, URL & CI
- 2 live versions per API
Growth
For fast-growing startups
$29per seat
/ month
/ month
Billed yearly
Get started for freeEverything in Free, plus
- Unlimited API versions
- Unlimited guides next to your API
- Custom domain
- Ask AI search
- SEO & LLM optimized
- API, MCP & webhooks
Professional
For scaling & multi-team orgs
$59per seat
/ month
/ month
Billed yearly
Get started for freeEverything in Growth, plus
- Private & segmented guides
- Login-protected docs
- AI translations (70+ languages)
- Single Sign-On (SSO)
- White-label add-on
- 20 free Lite seats
API docs are part of one Featurebase subscription, with your help center, support inbox, and more. 10-day free trial, no credit card required.
Frequently asked questions
What is API documentation?
API documentation explains how to use your API: every endpoint with its parameters, responses and code examples, plus guides such as authentication and quickstarts. Good API docs let developers, and now AI agents, build with your API without writing to you.
Can I create the docs from my OpenAPI file?
Yes. Import an OpenAPI 3.0 or 3.1 spec as a JSON or YAML file, from a public URL, or with a push from your CI. Every endpoint gets its own page, grouped by tag. Convert Swagger 2.0 files to OpenAPI 3 first.
How do the docs stay in sync with my API?
Link a URL that we check every 6 hours, or push the spec from your CI after each deploy, for example with GitHub Actions. Changes wait as a draft that lists what changed and marks breaking changes, until you publish them. You can also roll back to one of the last revisions.
Can developers test endpoints in the docs?
Yes. Try it sends real requests to the servers you allow, with the readerās own key. You can also show code samples only, or turn Try it off. The Free plan includes 500 Try it requests a day.
Which languages do the code examples cover?
Nine: cURL, JavaScript, TypeScript, Python, PHP, Go, Java, Ruby and C#. Your own samples from the spec come first, and every endpoint shows example responses for each status code.
Can I publish more than one version?
Yes. Publish API versions side by side. Readers switch with one menu, and a deprecated version shows a banner that points to the latest one. The Free plan includes 2 live versions.
Can I publish more than one API?
Yes. Add each API to the same help center. Each one gets its own tab and its own versions.
Can I combine API docs with guides?
Yes. Your API reference is a tab of your help center, with your guides in its sidebar. One search finds both, and Ask AI and Fibi answer from both.
Can AI tools like ChatGPT and Claude read our docs?
Yes. Every page has a Markdown version and opens in ChatGPT or Claude from its menu, and your guides and endpoints are listed in your llms.txt. Ask AI and Fibi answer from your API reference on the Growth plan and up.
Can I edit the docs from my AI tools?
Yes. Connect Claude or Cursor to our MCP server, then write and update your API docs and guides from there.
Can I host the docs on my own domain?
Yes. Your API reference uses your help centerās domain, colors, fonts and dark mode. A custom domain is on the Growth plan and up.
Can I keep some documentation private?
Yes. Make your help center private with sign-in, and your API reference is private too. Private help centers are on the Professional plan and up.
How do I move from another documentation tool?
Export your OpenAPI spec from ReadMe, Mintlify, Swagger or any other tool and import it. Bring your guides from Intercom, Zendesk or Crisp with one-click migration.
Is there a free plan?
Yes. API docs are on every plan, Free included, with Try it. See pricing.
Modern API docs developers enjoy and AI can read
Join 1600+ modern software companies on Featurebase. Import your OpenAPI spec and go live in minutes.