fa_amountToWords | Write an amount of Iranian rial or toman out in Persian words (مبلغ به حروف), as required on Iranian cheques, invoices and contracts. Use it to render a payable amount for a Persian-speaking payer. Returns the amount spelled in Persian words with its unit. ($0.005 per call, USDC on Base) |
fa_digits | Convert the digits inside a string between Persian (۰-۹), Arabic-Indic (٠-٩) and ASCII (0-9) numeral systems, leaving the rest of the text untouched. Use it to make Persian text machine-readable or to render an ASCII number in Persian script. Returns the converted string. ($0.003 per call, USDC on Base) |
fa_fixRtl | Remove Unicode bidi control characters and repair the spacing around right-to-left punctuation. Use it to clean Persian or Arabic text that renders in the wrong order or shows stray markers. Returns the cleaned string. ($0.005 per call, USDC on Base) |
fa_gregorianToJalali | Convert a Gregorian (ISO, Western) calendar date to the Jalali, Solar Hijri, Persian or Shamsi calendar used in Iran. Use it to display a date to Iranian users, to schedule work in the Iranian calendar, or to convert a Gregorian deadline into a Jalali date. Returns the Jalali year, month, day and month name. ($0.005 per call, USDC on Base) |
fa_iranCity | Look up an Iranian city by its Persian name and return the province it belongs to. Use it to resolve a city in an address or to group a location by region. Returns the city and its province. ($0.005 per call, USDC on Base) |
fa_iranHolidayCheck | Check whether a given Jalali (Solar Hijri) date is an Iranian public holiday and return the holiday's name if it is. Use it before booking, scheduling or sending a deadline-sensitive action on an Iranian working day. Returns whether it is a holiday and which one. ($0.005 per call, USDC on Base) |
fa_iranHolidays | Return the official Iranian public holidays for a Jalali (Solar Hijri) year, with each holiday's Gregorian date and name. Use it to plan delivery or support schedules around Iranian holidays, or to flag non-working days. Returns the holiday list. ($0.005 per call, USDC on Base) |
fa_iranProvince | Look up an Iranian province by its Persian name and return its capital and major cities. Use it to resolve a province in an address, to attach geographic context to a user, or to normalize a location field. Returns the province, its capital and its cities. ($0.005 per call, USDC on Base) |
fa_iranProvinces | List all 31 Iranian provinces with their capitals and major cities. Use it to populate a province dropdown, to build a location picker, or to validate a region name. Returns every province. ($0.003 per call, USDC on Base) |
fa_jalaliToGregorian | Convert a Jalali (Solar Hijri, Persian, Shamsi) calendar date to the Gregorian calendar. Use it to turn a date written in the Iranian calendar back into an ISO 8601 date, to check whether a Jalali date is today, or to compare an Iranian deadline with a Western one. Returns the Gregorian year, month, day and weekday. ($0.005 per call, USDC on Base) |
fa_keywords | Extract the frequent keywords from Persian text, filtering Persian and English stopwords and ranking by frequency. Use it to build a search index, an automatic tag list, or a topic summary for a Persian document. Returns the ranked keywords. ($0.01 per call, USDC on Base) |
fa_normalize | Normalize Persian (Farsi) text: convert Arabic letter variants (ي, ك) to their Persian forms, unify ZWNJ and spacing, and map Arabic-Indic digits to Persian digits. Use it before indexing, searching or comparing Persian text so that lookalike spellings match. Returns the normalized string. ($0.01 per call, USDC on Base) |
fa_numberToWords | Write an integer out in Persian words (عدد به حروف), for example 1234 as هزار و دویست و سی و چهار. Use it for Persian invoices, cheque amounts, legal and official forms, and display. Returns the number spelled in Persian words. ($0.01 per call, USDC on Base) |
fa_rialToman | Convert an amount between Iranian rial and toman, where 1 toman equals 10 rial. Use it when a price is given in one unit and must be shown or billed in the other. Returns the converted amount. ($0.003 per call, USDC on Base) |
fa_sentences | Split Persian text into sentences, handling the Persian question mark ؟, the exclamation mark, ellipsis … and abbreviation boundaries. Use it to chunk Persian text for summarization, translation or per-sentence processing. Returns the list of sentences. ($0.005 per call, USDC on Base) |
fa_similarity | Measure the similarity of two Persian strings as a trigram Jaccard score from 0 to 1. Use it to detect near-duplicate Persian text, deduplicate a corpus, or rank one Persian string against another. Returns the similarity score. ($0.01 per call, USDC on Base) |
fa_stats | Measure Persian text: character count, word count, line count and the number of ZWNJ half-space characters. Use it to size a Persian document, enforce a length limit, or report text statistics for Persian content. Returns a stats object. ($0.005 per call, USDC on Base) |
fa_stripHtml | Strip HTML tags and decode HTML entities out of a string, leaving the readable text behind. Use it to clean web pages or scraped content before feeding it to an agent or an index. Returns the plain text. ($0.005 per call, USDC on Base) |
fa_transliterate | Transliterate Persian, Dari or Arabic script into Latin letters, optionally as a URL slug. Use it to index Persian text in a Latin-keyword search engine, to build slugs for Persian titles, or to render Persian names in a Latin-only system. Returns the Latin transliteration and, when asked, the slug. ($0.01 per call, USDC on Base) |
fa_validateBankCard | Validate an Iranian bank card number, called a PAN (کارت بانکی), with the Luhn check digit, and return the issuing bank. Use it before charging a card or accepting card details from a customer. Returns validity, the masked number and the bank name. ($0.005 per call, USDC on Base) |
fa_validateCompanyId | Validate an Iranian company national ID (شناسه ملی اشخاص حقوقی, the 11-digit legal-entity identifier) by recomputing its check digit. Use it when onboarding a business customer or validating an Iranian legal entity. Returns validity and the parsed digits. ($0.005 per call, USDC on Base) |
fa_validateEconomicCode | Validate an Iranian economic code (کد اقتصادی, the 12-digit taxpayer identifier) by recomputing its check digit. Use it when validating the tax identifier on an Iranian invoice or a supplier record. Returns validity and the parsed digits. ($0.005 per call, USDC on Base) |
fa_validateLandline | Validate and normalize an Iranian landline number with its area code (021 for Tehran and so on) and resolve that area code to a city. Use it to verify a fixed-line contact or to route a support request to the right region. Returns validity, the normalized number, the area code and the city. ($0.005 per call, USDC on Base) |
fa_validateMobile | Validate and normalize an Iranian mobile phone number, checking the operator prefix (MCI, Irancell, Rightel, Shatel) and the national format 09xxxxxxxxx. Use it to verify a phone number on a sign-up form or before sending an SMS. Returns validity, the normalized number and the operator. ($0.005 per call, USDC on Base) |
fa_validateNationalId | Validate an Iranian national ID (کد ملی, code melli) by recomputing its check digit. Use it before accepting an identity number from a form, a customer, or an API payload. Returns whether the number is valid, and the parsed digits. ($0.005 per call, USDC on Base) |
fa_validatePostalCode | Validate an Iranian postal code (کد پستی, the 10-digit code) by recomputing its check digit. Use it before using a postal code for delivery or address validation. Returns validity, the normalized code and its province. ($0.005 per call, USDC on Base) |
fa_validateSheba | Validate an Iranian IBAN, called Sheba (شبا), with the ISO 13616 mod-97 check, and return the bank code. Use it before sending or crediting an Iranian bank transfer. Returns validity, the normalized IBAN and the bank identifier. ($0.005 per call, USDC on Base) |