Documentation

Learn how to build and manage APIs with Bapi

Getting Started

Welcome to Bapi! Follow these steps to create your first API:

  1. Create an Account - Sign up for a free Bapi account
  2. Build Your API - Use our API Builder to create your first API
  3. Add Endpoints - Configure endpoints that proxy to your target services
  4. Test & Deploy - Test your endpoints and make your API public

Creating an API

To create a new API:

  1. Navigate to API Builder
  2. Enter your API name and description
  3. Choose authentication type (if needed)
  4. Click "Create API"

Adding Endpoints

Endpoints are the individual routes in your API. Each endpoint can:

  • Accept different HTTP methods (GET, POST, PUT, DELETE, etc.)
  • Have path parameters (e.g., /user/{id})
  • Have query parameters
  • Include custom headers
  • Transform request/response data

Authentication

Bapi supports multiple authentication methods:

  • None - Public APIs with no authentication
  • Header-based - Custom headers for client authentication
  • Cookie-based - Automatic session management
  • Bearer Token - Token-based authentication

Using Your API

Once created, your API is available at:

https://bapi.ai/{username}/{api-slug}/{endpoint}

Example Request

curl https://bapi.ai/{username}/weather-api/current?city=London

Best Practices

  • Use descriptive names for your APIs and endpoints
  • Document your APIs using the Documentation tab
  • Set appropriate visibility (public/private)
  • Monitor your API usage and request counts
  • Use environment-specific credentials

Need Help?

If you have questions or need support, please contact us.