API کا جائزہ

KeepFlow API، REST کے گرد منظم ہے۔ ہمارے API میں قابلِ پیش گوئی، وسائل پر مبنی URLs ہیں، یہ JSON میں انکوڈ کردہ درخواست باڈیز قبول کرتا ہے، JSON میں انکوڈ کردہ ریسپانسز واپس کرتا ہے، اور معیاری HTTP ریسپانس کوڈز استعمال کرتا ہے۔

بیس URL

https://api.keepflow.ai/v1

درخواست کا فارمیٹ

تمام درخواستوں میں یہ شامل ہونا ضروری ہے:

• Content-Type: application/json ہیڈر
• Authorization: Bearer <api_key> ہیڈر

ریسپانس کا فارمیٹ

تمام ریسپانسز ایک یکساں ڈھانچے کی پیروی کرتے ہیں:

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-03-15T10:30:00Z"
  }
}

ایرر ہینڈلنگ

ایررز مناسب HTTP اسٹیٹس کوڈز کے ساتھ ایک وضاحتی پیغام واپس کرتے ہیں:

{
  "error": {
    "code": "invalid_request",
    "message": "The 'email' field is required."
  }
}