Relationship Compatibility API - V1 Endpoint

Overview

AI-powered compatibility analysis for relationships

Request

curl -X POST "https://api.vedika.io/api/v1/compatibility" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "person1": {
      "dateOfBirth": "1990-05-15",
      "timeOfBirth": "10:30",
      "latitude": 19.07,
      "longitude": 72.87,
      "placeOfBirth": "Mumbai, India"
    },
    "person2": {
      "dateOfBirth": "1992-08-22",
      "timeOfBirth": "14:15",
      "latitude": 28.61,
      "longitude": 77.21,
      "placeOfBirth": "Delhi, India"
    },
    "analysisType": "comprehensive"
  }'

Parameters

Parameter	Type	Required	Description
`person1`	object	-	See the request example
`person2`	object	-	See the request example
`analysisType`	string	-	See the request example

Response

{
  "success": true,
  "data": {
    // Endpoint-specific response data
  },
  "metadata": {
    "requestId": "req_123456",
    "timestamp": "2026-01-07T00:00:00Z",
    "cost": 0.35
  }
}

Error Handling

{
  "success": false,
  "error": {
    "code": "INVALID_DATETIME",
    "message": "Invalid datetime format. Use ISO 8601.",
    "details": { ... }
  }
}

Rate Limits

Free Sandbox: Mock data for testing (no auth required)
Starter ($12/mo): 300 credits/month
Pro ($60/mo): 1,500 credits/month
Business ($120/mo): 3,000 credits/month
Enterprise ($240/mo): 6,000 credits/month
Enterprise ($240/mo): 6,000 credits + custom limits

SDKs

JavaScript/Node.js

const { VedikaClient } = require('@vedika-io/sdk');

const client = new VedikaClient({ apiKey: 'YOUR_API_KEY' });

async function main() {
  const result = await client.post('/api/v1/compatibility', {
    person1: {
      dateOfBirth: '1990-05-15',
      timeOfBirth: '10:30',
      latitude: 19.07,
      longitude: 72.87,
      placeOfBirth: 'Mumbai, India'
    },
    person2: {
      dateOfBirth: '1992-08-22',
      timeOfBirth: '14:15',
      latitude: 28.61,
      longitude: 77.21,
      placeOfBirth: 'Delhi, India'
    },
    analysisType: 'comprehensive'
  });
  console.log(result);
}

main().catch(console.error);

Python

from vedika import VedikaClient

client = VedikaClient(api_key="YOUR_API_KEY")
result = client.request("POST", "/api/v1/compatibility", json={
    "person1": {
        "dateOfBirth": "1990-05-15",
        "timeOfBirth": "10:30",
        "latitude": 19.07,
        "longitude": 72.87,
        "placeOfBirth": "Mumbai, India"
    },
    "person2": {
        "dateOfBirth": "1992-08-22",
        "timeOfBirth": "14:15",
        "latitude": 28.61,
        "longitude": 77.21,
        "placeOfBirth": "Delhi, India"
    },
    "analysisType": "comprehensive"
})
print(result)

Relationship Compatibility

Overview

Request

Parameters

Response

Error Handling

Rate Limits

SDKs

JavaScript/Node.js

Python

Ready to Build with Vedika?