Developer Documentation

Get started with VetPro AI API in minutes. Simple authentication, clear examples, and comprehensive documentation.

Getting Started

Create a free developer account to get your API keys and start building.

Step 1: Sign Up

Create your developer account to access the API. It's free and takes less than a minute.

Create Account →

Step 2: Generate API Key

After signing up, log in to your dashboard and generate your first API key. You can create multiple keys for different environments (production, staging, testing).

Go to Dashboard →

Authentication

All API endpoints require authentication using an X-API-Key header. Get your API key from your developer dashboard.

API Key Authentication

Include your API key in the X-API-Key header with every request:

curl -X POST https://api.vetprocloud.com/api/v1/ai/visit-summary \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{...}'
                

Your API key is tied to your developer account and includes rate limits and usage tracking. Manage your keys from the developer dashboard.

Example Request

All endpoints accept the same payload format. Here's an example for the Visit Summary endpoint:

Visit Summary Request

POST /api/v1/ai/visit-summary
Headers:
  X-API-Key: your-api-key-here
  Content-Type: application/json

Body:
{
  "data": [
    {
      "type": "PatientRecord",
      "location": "Main Clinic",
      "timestamp": "2025-01-15T10:30:00Z",
      "visit": {
        "id": "visit-12345",
        "date": "2025-01-15",
        "purpose": "Annual checkup",
        "notes": "Patient examination notes..."
      },
      "history": [
        {
          "id": "record-1",
          "type": "vaccination",
          "name": "Rabies",
          "nextDue": "2026-01-15"
        }
      ]
    }
  ],
  "options": {
    "limit": 5,
    "includeHistory": true
  }
}
                

Response Format

{
  "success": true,
  "data": {
    "content": "Generated summary text...",
    "references": ["visit-12345"],
    "relatedRecords": ["record-1"],
    "metadata": {
      "tokensUsed": 1250,
      "processingTimeMs": 2340,
      "model": "claude-3-5-haiku-20241022"
    }
  }
}
                

API Endpoints

POST /api/v1/ai/visit-summary

Generate comprehensive visit summaries from patient history. Includes diagnoses, treatments, and recommendations.

POST /api/v1/ai/smart-snapshot

Get a complete patient overview with key findings, active concerns, and upcoming vaccinations.

POST /api/v1/ai/message-draft

Generate professional message drafts for clients with customizable tone and context.

POST /api/v1/ai/alerts

Detect patterns and generate alerts for missing vaccinations, incomplete treatments, and follow-ups.

POST /api/v1/ai/analytics

Generate trends, insights, and analytics from visit and vaccination data over time.

Webhooks

Configure webhooks to receive real-time notifications for API events and async processing.

Webhook Configuration

Set up webhooks in your dashboard to receive notifications for:

API request completion
Error notifications
Rate limit warnings
Usage threshold alerts

POST https://your-app.com/webhooks/vetpro
Headers:
  X-Webhook-Signature: sha256-hmac-signature
  Content-Type: application/json

Body:
{
  "event": "api.completed",
  "endpoint": "/api/v1/ai/visit-summary",
  "clinicId": "clinic-123",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {...}
}
                

Rate Limits

Default Tier

100 requests/minute per API key. Suitable for most integrations.

Rate Limit Headers

Every response includes rate limit information:

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset

Higher Tiers

Enterprise plans available with custom rate limits. Contact sales for details.

Full API Documentation

Interactive API Docs

For complete API documentation, including request/response schemas, error codes, and code examples, visit our interactive API documentation portal.

View Full Documentation →

Ready to Get Started?

Join veterinary software platforms using VetPro AI API to enhance their services

View Full API Docs Contact Sales