Skip to main content
POST
Create a Decision

Request body

Always required

object
required
The property to evaluate.
boolean
required
false - scoring engine only (1 credit). Returns score and breakdown, no explanation.true - scoring engine + AI reasoning (3 credits). Adds a reasoning string to the response.

Type-specific required fields

number
required
Number of bedrooms.
number
required
Number of bathrooms.
number
required
Floor number. Use 0 for ground floor.
boolean
required
Whether the building has a working elevator.

Optional

string
Buyer intent. own_use or investment. Shapes how the scoring weights price vs. ROI.
number
Maximum budget. When provided, price scoring is relative to this value.
number
Minimum acceptable ROI percentage. Only relevant when purpose is investment.
string
Free-text context for the AI. Only used when reasoning: true. E.g. "relocating from Riyadh, needs school proximity".
string
default:"ar"
Response language for the reasoning field. ar or en. Only used when reasoning: true.

Response

string
match, partial, or no_match. Derived from score: 70+ is match, 40-69 is partial, below 40 is no match.
number
Overall score from 0 to 100.
string
high, medium, or low. Reflects how much data was provided - more optional fields raise confidence.
object
Per-bucket scores and statuses.
string
Plain-language explanation of the verdict. Only present when reasoning: true.
number
Credits consumed by this request. 1 for scoring only, 3 for reasoning.
number
Your remaining decision balance after this request.

Examples