API Reference

BPP exposes a REST API for programmatic access to all platform resources — audiences, signals, AI model instances, connections, and more.

Base URL

https://<your-instance>.bpp.bytek.ai/api/v1/

Replace <your-instance> with your environment subdomain (e.g., dev-2 for the development environment).

All API requests require authentication. BPP supports two methods:

Obtain a JWT token by posting your credentials:

POST /api/v1/jwt/create/
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "yourpassword"
}

Use the returned access token in all subsequent requests:

Authorization: Bearer <access_token>

Refresh the token before it expires:

POST /api/v1/jwt/refresh/
Content-Type: application/json

{
  "refresh": "<refresh_token>"
}

For automated integrations (e.g., custom scripts, ETL pipelines), BPP accepts a static API key:

Authorization: Api-Key <your-api-key>

Static API keys are provisioned by your BPP administrator.

See Authentication for more details.

All responses are JSON. Standard HTTP status codes apply:

Code	Meaning
`200 OK`	Successful GET or PATCH.
`201 Created`	Successful POST — resource created.
`204 No Content`	Successful DELETE.
`400 Bad Request`	Validation error — response body contains error details.
`401 Unauthorized`	Missing or invalid authentication.
`403 Forbidden`	Authenticated but not permitted to access this resource.
`404 Not Found`	Resource does not exist.

List endpoints return paginated results:

{
  "count": 42,
  "next": "https://.../api/v1/audiences/?page=2",
  "previous": null,
  "results": [...]
}

Most list endpoints support query parameter filtering:

GET /api/v1/audiences/?customer=1
GET /api/v1/signals/?status=2

See Endpoints for the full resource reference.