​
API Overview

The Bila API is organized around REST principles, with resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

We also offer a GraphQL API for more flexible querying capabilities.

​
Base URLs

EnvironmentBase URL
Productionhttps://api.usebila.com/v1
Sandboxhttps://sandbox.usebila.com/v1

We strongly recommend using our sandbox environment for testing before moving to production.

​
Authentication

The Bila API uses API keys to authenticate requests. You can view and manage your API keys in the Bila Console.

Authentication to the API is performed via HTTP Bearer Authentication. Provide your API key as the bearer token value in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Your API keys carry many privileges, so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, etc.

​
Request/Response Format

​
Content Type

All requests should include the following header:

Content-Type: application/json

​
Request Structure

{
  "field1": "value1",
  "field2": "value2",
  // ...
}

​
Response Structure

All API responses include a standard structure:

{
  "status": "success", // or "error"
  "data": {
    // Response data here
  },
  "message": "Operation successful", // Human-readable message
  "code": 200 // HTTP status code
}

​
Error Handling

The Bila API uses conventional HTTP response codes to indicate the success or failure of an API request:

  • 2xx range indicates success
  • 4xx range indicates an error that failed given the information provided (e.g., a required parameter was omitted)
  • 5xx range indicates an error with Bila’s servers

​
Error Response Format

{
  "status": "error",
  "error": {
    "code": "error_code",
    "message": "Human-readable error message",
    "details": {
      // Additional error details
    }
  },
  "code": 400 // HTTP status code
}

For more information on error handling, see our Error Handling Guide.

​
Rate Limits

The Bila API implements rate limiting to protect our infrastructure and ensure fair usage. Current limits are:

  • 100 requests per minute per API key
  • 5,000 requests per day per API key

For more information on rate limits, see our Rate Limits Guide.

​
Versioning

The Bila API is versioned using a date-based versioning scheme. The current version is v1.

When we make backwards-incompatible changes to the API, we release a new dated version. You can specify which version to use by including it in the request URL:

https://api.usebila.com/v1/...

​
Webhooks

Bila can send webhook events to notify your application when specific events occur. For more information, see our Webhooks Guide.

​
SDKs and Libraries

We provide official client libraries for several popular programming languages:

Node.js

Official Node.js library for the Bila API

Python

Official Python library for the Bila API

PHP

Official PHP library for the Bila API

​
Getting Help

If you have any questions or need help with the API, you can: