Buddy Developers

Developer resources

Developer tools

Download API definitions for your development tools. To browse endpoints and examples, use the API reference.

OpenAPI specification

The OpenAPI 3.1 JSON file describes Buddy’s endpoints, request fields, responses, and authentication. Import it into compatible tools to explore the API or generate a client.

Download OpenAPI specification (.json)

Import the specification

  1. Download the file, or copy the specification URL.
  2. In Postman or another OpenAPI-compatible tool, choose its import action.
  3. Select the downloaded JSON file or paste the URL. In Postman, choose a collection when prompted to generate requests.

The specification URL returns JSON directly so tools can read it. It stays available without signing in.

Postman collection

Import ready-made requests into Postman, then supply your own API key and request values.

Download Postman collection (.json)

Import and configure requests

  1. Download the collection and open Postman.
  2. Choose Import and select the downloaded JSON file.
  3. Review base_url and set api_key privately to your own test key. The collection defaults to https://usebuddy.app/api/v1. Test and live keys use this same URL; start with a test key for simulated requests.
  4. Replace request placeholders, then follow the quickstart to check your connection.

Keep API keys private. Do not publish or share a collection containing a real key. Use test mode while building your integration.