HI
API & MCPदस्तावेज़ीकरण

Road User Tools एजेंट और API प्लेटफ़ॉर्म

सीमाएँ और सत्यापन

Road User Tools गणना से पहले अनुरोधों का सत्यापन करता है और अनुरोध पूरा न हो पाने पर सुसंगत, मशीन-पठनीय त्रुटियाँ लौटाता है।

अनुरोध सीमा

JSON अनुरोध निकाय तक सीमित हैं16 KiB. गणना से पहले इनपुट को मान्य किया जाता है, जिसमें समर्थित इकाइयाँ, परिमित संख्यात्मक मान, अप्रत्याशित फ़ील्ड और गैर-नकारात्मक दूरी जैसी मान श्रेणियाँ शामिल हैं।

सार्वजनिक API सूचकांक

GET /api/v1प्रमाणीकरण के बिना उपलब्ध है और बुनियादी API जानकारी प्रदान करता है। टूल खोज, गणना और MCP अनुरोधों के लिए एक वैध API कुंजी की आवश्यकता होती है।

त्रुटियाँ

REST त्रुटियाँ मानव-पठनीय संदेश के साथ एक स्थिर मशीन-पठनीय कोड लौटाती हैं। MCP ट्रांसपोर्ट त्रुटियाँ JSON-RPC फ़ॉर्मेटिंग का उपयोग करती हैं और Road User Tools त्रुटि कोड इस फ़ील्ड में शामिल होता है:error.data.code.

REST त्रुटिjson
{
  "ok": false,
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Try again shortly."
  }
}
400invalid_requestअनुरोध का मुख्य भाग या उसका एक फ़ील्ड अमान्य है.
401unauthorizedAPI कुंजी गुम है, विकृत है, निरस्त है, या पहचानी नहीं गई है।
403forbiddenAPI कुंजी में आवश्यक दायरा नहीं है।
404not_foundअनुरोधित समापन बिंदु मौजूद नहीं है.
413payload_too_largeअनुरोध का मुख्य भाग 16 KiB से अधिक है।
415unsupported_media_typeसमापन बिंदु के लिए एक की आवश्यकता है application/json अनुरोध.
429rate_limitedअनुरोध सीमा पूरी हो चुकी है. शीघ्र ही पुनः प्रयास करें.
500internal_errorसेवा अनुरोध पूरा नहीं कर सकी.
API और MCP दस्तावेज़