Download the Bevy OpenAPI JSON from Bevy API Reference, import it into Postman as a collection, then set baseUrl and apiKey so you can send authenticated requests. Importing the spec does not store a working token and does not run any requests for you.
Postman can turn the Bevy public API OpenAPI JSON into a request collection. Use this when you want to explore endpoints locally before you build an integration. For base URL, authentication, versioning, and rate limits, see Using Public Bevy APIs. Endpoint details stay in Bevy API Reference.
Note: Importing the OpenAPI file creates folders and request templates from the spec. It does not store a working API token for your community, and it does not send any requests until you set variables and click Send.
Download the OpenAPI JSON
- Open Bevy API Reference.
- Use Download on that page (the download control on the API reference viewer, not a file attached in the Guide article body).
- Save the
openapi.jsonfile on your computer.
Import the spec as a Postman collection
- In Postman, select Import.
- Upload the OpenAPI JSON file you downloaded.
- Review the import options, then choose to generate a collection from the spec.
- Finish the import.
You should see the imported collection in Collections. Postman may also keep an API definition from the same file. Label names can vary slightly by Postman version; use the collection that lists the Bevy public API operations.
Set baseUrl and apiKey
Open the imported collection, then open its Variables tab. Set at least:
-
baseUrl — your community base URL plus
/api. Example:https://your-community.example/api. -
apiKey — the Authorization header value: the word
Token, a space, then your Bevy API key. Example:Token your-api-key-here.
Get or reset the key in Manage your Bevy API key. Only HQ administrators can view and reset that key. After you save the variables, open a request in the collection, confirm it uses those variables, and send it when you are ready to test.
Tip: If a request fails with an authentication error, check that apiKey includes the Token prefix and a space, and that the key was not reset after you copied it. If the host is wrong, check that baseUrl ends with /api and matches your community domain.
Important: Treat the API key like a password. Do not share collection exports that include a real apiKey value. Prefer a Postman environment or secret store for production keys.