Machine API রেফারেন্স

Generated অপারেশন এবং মেশিন-পাঠযোগ্য discovery।

সর্বশেষ আপডেট: ৩০ সেপ, ২০২৬

এই রেফারেন্স কীভাবে পড়বেন

অপারেশন তালিকা OpenAPI-এর মতো একই registry থেকে generate করা হয়, পুরোনো ডকুমেন্টেশন থেকে কপি করা নয়। Method, path, Scope, শর্তসাপেক্ষ Scope এবং idempotency সমর্থন registry অনুসরণ করে; ব্যাখ্যাগুলো operationId দিয়ে key করা একটি অনূদিত dictionary থেকে আসে। অচেনা অপারেশনের জন্য প্রতিটি ভাষায় অনুবাদ প্রয়োজন, নীরবে ইংরেজি দেখানোর বদলে।

OpenAPI বর্তমানে অনেক অপারেশনের জন্য generic request/response object ব্যবহার করে। এর generic wallet request উদাহরণ প্রতিটি POST-এর জন্য বৈধ payload নয়। ওই workflow-গুলোর জন্য authentication, টপআপ এবং Watchdog-এর যাচাইকৃত উদাহরণ ব্যবহার করুন। ডকুমেন্টটি একটি discovery রেফারেন্স, প্রতিটি রুট একই response status বা field ভাগ করে নেয় এমন কোনো দাবি নয়।

API-এর সীমানা

এই মডিউল x402 মেশিন বিলিং এবং Watchdog অটোমেশন কভার করে। মিটার করা ডেটা রুট তাদের বিদ্যমান API ব্যবহার করে এবং আলাদাভাবে তালিকাভুক্ত। MCP একটি read-only tool interface, যার আলাদা OAuth account ফ্লো আছে; এই মডিউল এর বাস্তবায়ন পরিবর্তন করে না। Credits এবং MCP ব্যবহারকারী গাইড আলাদা ডকুমেন্টেশন অংশ।

অপারেশন রেফারেন্স

  • GET /api/x402/account — Scope: read; Credit ব্যালেন্স এবং ledger পান.
  • GET /api/x402/account/terms — Scope: read; Terms গ্রহণের অবস্থা পান.
  • POST /api/x402/account/terms — Scope: write; বর্তমান terms গ্রহণ করুন.
  • GET /api/x402/alerts — Scope: read; Alert history তালিকা করুন.
  • DELETE /api/x402/alerts — Scope: write; নির্বাচিত alert history মুছুন.
  • DELETE /api/x402/alerts/{id} — Scope: write; একটি alert মুছুন.
  • GET /api/x402/alerts/export — Scope: read; Alert history CSV হিসেবে export করুন.
  • POST /api/x402/auth/challenge — Scope: Authentication নেই; Scope-সহ SIWE challenge তৈরি করুন.
  • POST /api/x402/auth/token — Scope: Authentication নেই; সাইন করা SIWE-কে bearer token-এ বিনিময় করুন.
  • GET /api/x402/auth/tokens — Scope: read; ওয়ালেটের API token তালিকা করুন.
  • DELETE /api/x402/auth/tokens/{id} — Scope: write; একটি API token প্রত্যাহার করুন.
  • GET /api/x402/channels — Scope: read; Channel status তালিকা করুন.
  • PUT /api/x402/channels/{key} — Scope: write; একটি input channel কনফিগার করুন; Idempotency-Key সমর্থিত.
  • DELETE /api/x402/channels/{key} — Scope: write; একটি channel target সরান.
  • POST /api/x402/channels/{key}/test — Scope: write; একটি channel টেস্ট পাঠান.
  • POST /api/x402/message-preview — Scope: read; একটি localized বার্তার প্রিভিউ দেখুন.
  • GET /api/x402/openapi.json — Scope: Authentication নেই; এই OpenAPI ডকুমেন্ট পান.
  • GET /api/x402/pricing — Scope: Authentication নেই; মূল্য, প্রোডাক্ট, watch, signal এবং সহায়তা আবিষ্কার করুন.
  • GET /api/x402/provider-fsp — Scope: read; Provider FSP view পান.
  • GET /api/x402/recipients — Scope: read; নামযুক্ত recipient তালিকা করুন.
  • POST /api/x402/recipients — Scope: write; একটি input recipient তৈরি করুন; Idempotency-Key সমর্থিত.
  • PATCH /api/x402/recipients/{id} — Scope: write; একটি recipient আপডেট করুন.
  • DELETE /api/x402/recipients/{id} — Scope: write; একটি recipient মুছুন.
  • POST /api/x402/recipients/{id}/test — Scope: write; একটি recipient টেস্ট করুন.
  • POST /api/x402/recipients/telegram-link — Scope: write; একটি Telegram recipient link তৈরি করুন.
  • GET /api/x402/settings — Scope: read; নোটিফিকেশন সেটিংস পান.
  • PUT /api/x402/settings — Scope: write; নোটিফিকেশন সেটিংস প্রতিস্থাপন করুন.
  • GET /api/x402/stats — Scope: Authentication নেই; পাবলিক বিলিং সমষ্টি পান.
  • GET /api/x402/subscriptions — Scope: read; সাবস্ক্রিপশন এবং ক্যাপাসিটি তালিকা করুন.
  • POST /api/x402/subscriptions — Scope: spend; সাবস্ক্রিপশন ক্যাপাসিটি কিনুন; Idempotency-Key সমর্থিত.
  • PATCH /api/x402/subscriptions — Scope: write (autoRenew true হলে spend); Auto-Renew আপডেট করুন.
  • GET /api/x402/subscriptions/quote — Scope: read; সাবস্ক্রিপশন ক্যাপাসিটির quote নিন.
  • POST /api/x402/subscriptions/trial — Scope: write; এককালীন trial শুরু করুন.
  • POST /api/x402/topup — Scope: write; একটি টপআপ draft তৈরি করুন; Idempotency-Key সমর্থিত.
  • GET /api/x402/topup/{handle} — Scope: read; টপআপ status পান.
  • POST /api/x402/topup/{handle}/confirm — Scope: write; একটি টপআপ লেনদেন confirm করুন.
  • GET /api/x402/watches — Scope: read; Watch তালিকা করুন.
  • POST /api/x402/watches — Scope: write; একটি watch তৈরি করুন; Idempotency-Key সমর্থিত.
  • GET /api/x402/watches/{id} — Scope: read; একটি watch পান.
  • PATCH /api/x402/watches/{id} — Scope: write; একটি watch আপডেট করুন.
  • DELETE /api/x402/watches/{id} — Scope: write; একটি watch মুছুন.