Aurelia developer docs

Tools

All tools are read-only (readOnlyHint: true). This page is generated from the server's tool registry.

Public

gold_price_getpublic

Get today's gold price in AED per gram for 24K, 22K, 21K and 18K. Use when the user asks about the gold price. Never predict future prices.

No arguments.

borrowing_estimatepublic

Estimate how much the user could borrow against their gold: up to 75% of value as a gold-backed loan, up to 70% as a gold-backed card limit. Use basis='photo_valuations' after gold_identify has valued their photos in this conversation; use basis='self_reported' with karat and weight_g when the user describes their gold in words. All amounts are INDICATIVE; the lender sets the final amount after certified appraisal.

ArgumentTypeNotes
basis requiredstring: photo_valuations self_reported
karatnumberOnly for self_reported: 24, 22, 21 or 18
weight_gnumberOnly for self_reported: weight in grams

products_comparepublic

Compare the gold-backed loan and the gold-backed card in plain language. Use when the user asks which product suits them or how they differ. Recommend a fit based on what the user said they need; never pressure.

No arguments.

jewellers_listpublic

List Dhahaby's verified partner jewellers in the UAE where gold can be appraised (certified), with city, address and the earliest free slot. Read-only.

No arguments.

handoff_to_apppublic

Give the user a link to continue in the Aurelia app (photo valuation, appraisal booking, signing up). Use when the user wants to act, not just ask.

ArgumentTypeNotes
topicstring: value_gold borrow book_appraisal general

With sign-in

account_context_getsign-in

Overview of the user's Dhahaby account: home state (0-5), active appraisal bookings and unread notifications. Read-only; acts as the signed-in user.

No arguments.

pieces_listsign-in

The user's gold pieces with status, lifecycle stage, AI (indicative) and certified values, and the next possible finance action for each. Read-only; acts as the signed-in user.

No arguments.

Note: platform expires stale card handovers on read.

piece_getsign-in

Details of one gold piece: certificate, appraisal result and custody status. Read-only; acts as the signed-in user.

ArgumentTypeNotes
ref requiredstringReference such as DHY-G-20261023-ABC123

loan_eligibility_getsign-in

Which pieces can back a gold-backed loan now (scenario A/B/C/D) and the maximum loan per piece. Read-only; acts as the signed-in user.

No arguments.

Note: platform expires stale saved offers on read.

card_eligibility_getsign-in

Which pieces can back the gold-backed card and the limits (immediate, after handover, provisional). Read-only; acts as the signed-in user.

No arguments.

Note: platform runs card expiry sweeps on read.

loan_application_getsign-in

The user's latest loan application: status and customer_next_step. Read-only; acts as the signed-in user.

No arguments.

card_application_getsign-in

The user's latest card application: status and next step. Read-only; acts as the signed-in user.

No arguments.

Note: platform runs card expiry sweeps on read.

loan_facilities_listsign-in

The user's active gold-backed loans (facilities): outstanding amounts, status and pledged pieces. Read-only; acts as the signed-in user.

No arguments.

card_facility_getsign-in

The user's gold-backed card facility: limit, available amount, status and pledged pieces. Read-only; acts as the signed-in user.

No arguments.

Note: platform runs card expiry sweeps on read.

appraisal_bookings_listsign-in

The user's appraisal appointments with jewellers and their results. Read-only; acts as the signed-in user.

No arguments.

kyc_status_getsign-in

The user's identity verification (UAE PASS) status. ID numbers are masked. Read-only; acts as the signed-in user.

No arguments.

notifications_listsign-in

The user's latest Dhahaby notifications. Read-only; acts as the signed-in user.

No arguments.

activity_listsign-in

Recent activity on the user's account (appraisals, applications, custody, payments). Read-only; acts as the signed-in user.

No arguments.

documents_listsign-in

The user's documents (certificates, agreements, receipts): titles and dates only, no files. Read-only; acts as the signed-in user.

No arguments.