⌨ Developer Documentation

Build on top of BloomPetOS

Integrate veterinary clinics, grooming salons, boarding centers, marketplaces, AI assistants and pet-care workflows using secure APIs, webhooks, SDKs and developer tools.

200+
Endpoints
99.98%
Availability
OAuth2
Secured
REST
+ Webhooks
Versioned
APIs
Getting Started

Secure authentication

BloomPetOS uses OAuth2 client-credentials with scoped access tokens (JWT). Exchange your API keys for a short-lived bearer token, then call any endpoint. Refresh tokens and fine-grained scopes are supported.

OAuth2JWTAPI KeysScopesRefresh Tokens
curl -X POST https://api.bloompetos.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "pk_live_8f2c...",
    "client_secret": "sk_live_d91a...",
    "scope": "pets bookings ai.read"
  }'
Response · 200 OK
{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "pets bookings ai.read",
  "refresh_token": "rt_2c9f..."
}
Major Feature

Interactive API playground

Select an endpoint, execute a request and inspect the response — then copy the generated snippet in cURL, Java, Spring Boot, JavaScript, TypeScript, Python or React Native.

POST request
curl -X POST https://api.bloompetos.com/v1/appointments \
  -H "Authorization: Bearer $TOKEN"
Press Execute to view a sample response
Core APIs

Create an appointment

A typical write — book a vet consultation for a pet. All write endpoints accept an Idempotency-Key so retries never double-book.

curl -X POST https://api.bloompetos.com/v1/appointments \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: a1b2c3" \
  -d '{
    "petId": "pet_9F2a",
    "providerId": "prv_vet_07",
    "type": "VET_CONSULTATION",
    "startsAt": "2026-06-12T10:30:00+05:30",
    "notes": "Annual check-up + vaccination review"
  }'
Response · 201 Created
{
  "id": "appt_7Kd2",
  "status": "CONFIRMED",
  "petId": "pet_9F2a",
  "provider": { "id": "prv_vet_07", "name": "Dr. Meera" },
  "type": "VET_CONSULTATION",
  "startsAt": "2026-06-12T10:30:00+05:30",
  "createdAt": "2026-06-03T08:14:55Z"
}
AI Platform

AI Platform APIs

First-class APIs for assistants, retrieval-augmented generation, agents, workflows and analytics — purpose-built for pet care.

AI Assistant APIRAG APIAgent Workflow APIRecommendation APIAnalytics APIPet Health Insights API
// 1. Create an AI assistant scoped to a clinic
const assistant = await bp.ai.assistants.create({
  name: "Front-desk assistant",
  scope: "clinic_chennai",
  tools: ["bookings", "pet_records", "vaccinations"],
});

// 2. Upload knowledge for RAG
await bp.ai.knowledge.upload({
  assistantId: assistant.id,
  files: ["clinic-policies.pdf", "vaccination-schedule.md"],
});

// 3. Query the knowledge base
const answer = await bp.ai.knowledge.query({
  assistantId: assistant.id,
  question: "When is Bruno's next rabies booster due?",
});
Unique differentiator

Knowledge Assistant (RAG)

Upload clinic policies, vaccination schedules and pet records; BloomPetOS indexes them into a vector store and answers questions with cited context.

📤 Document Upload🧩 Knowledge Indexing🔎 Vector Search🧠 Semantic Search💬 Answer Generation📎 Context Retrieval
AI Workflow Engine

Agentic workflows

Compose multi-step agents that watch events and act — reminders, follow-ups, onboarding and lead qualification.

Appointment Follow-Up
TriggerAgentAction
Vaccination Reminder
TriggerAgentAction
Boarding Check-In Workflow
TriggerAgentAction
Pet Health Follow-Up
TriggerAgentAction
Marketplace Lead Qualification
TriggerAgentAction
Provider Onboarding
TriggerAgentAction
Real-Time Events

Webhooks

Subscribe to events and receive signed payloads. Deliveries are retried with exponential backoff for 24h; verify the X-Bloom-Signature header before trusting a payload.

booking.createdbooking.cancelledappointment.completedpayment.succeededvaccination.dueprovider.approvedpet.registered
Payload sample · signed
POST https://your-app.com/webhooks/bloompetos
X-Bloom-Signature: t=1717400000,v1=5d41402abc4b2a...

{
  "id": "evt_3Fa9",
  "type": "booking.created",
  "createdAt": "2026-06-03T08:20:11Z",
  "data": {
    "bookingId": "bkg_8821",
    "petId": "pet_9F2a",
    "service": "BOARDING",
    "amount": 4800,
    "currency": "INR"
  }
}
Download Center

SDKs for every stack

Java SDK
implementation 'com.bloompetos:sdk:2.4.0'
🍃Spring Boot SDK
bloompetos-spring-boot-starter:2.4.0
🟢Node SDK
npm i @bloompetos/sdk
⚛️React SDK
npm i @bloompetos/react
📱React Native SDK
npm i @bloompetos/react-native
🐦Flutter SDK
flutter pub add bloompetos
🐍Python SDK
pip install bloompetos
Implementation

Implementation playbooks

Vet Clinic Setup~2 days
Boarding Center Setup~3 days
Grooming Salon Setup~1 day
Marketplace Setup~5 days
Enterprise Setup~2 weeks
Multi-Location Setup~1 week
Platform Architecture

How BloomPetOS is built

Microservices
API Gateway
AI Layer
RAG Layer
Workflow Engine
Analytics
Mobile Apps
Marketplace
Admin Dashboard
Tooling

Postman & OpenAPI

Reliability

Errors & rate limits

StatusMeaningAction
400Validation errorFix the request body
401Invalid / expired tokenRefresh the OAuth2 token
429Rate limit (600 req/min)Back off + retry with jitter
5xxServer errorRetry idempotently
Built for enterprise teams

Enterprise readiness

99.98%
Uptime SLA
OAuth2
Secured
SOC2
Ready
Multi-Tenant
Isolation
Audit Trails
Every call
Versioned
APIs
Rate
Limiting

Start building with BloomPetOS today

A serious API-first platform you can confidently build on.