> ## Documentation Index
> Fetch the complete documentation index at: https://docs.noimosai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API संदर्भ

> बेस URL, एंडपॉइंट, उत्तर, त्रुटियाँ और उपयोग सीमाएँ।

## अवलोकन

यह पेज Developer Platform API के साझा कनेक्शन विवरण, एंडपॉइंट, उत्तर, त्रुटियाँ और सीमाएँ बताता है। टूल के स्कीमा और वर्तमान कीमतें `GET /tools` से लें।

## बेस URL और हेडर

सभी पाथ इस बेस URL के बाद जोड़ें।

```text theme={null}
https://api.noimosai.com/noimosToolBridge
```

Developer Platform कुंजी से प्रमाणित करें। JSON बॉडी के लिए Content-Type दें।

```http theme={null}
Authorization: Bearer nmp_...
Content-Type: application/json
```

सशुल्क निष्पादन में यह हेडर भी चाहिए।

```http theme={null}
Idempotency-Key: request-unique-id
```

## एंडपॉइंट

मुख्य सार्वजनिक API एंडपॉइंट ये हैं।

| मेथड और पाथ | आवश्यक अनुमति | उपयोग |
| - | - | - |
| `GET /tools/project` | `project:read` | कुंजी का संगठन और प्रोजेक्ट पढ़ना |
| `GET /tools/usage` | `usage:read` | चालू UTC महीने के अंतिम अनुरोध और USD शुल्क पढ़ना |
| `GET /tools` | `tools:read` | टूल, स्कीमा, उदाहरण, उपलब्धता और कीमतें लेना |
| `POST /tools/quote` | `tools:read` | इनपुट की अधिकतम आरक्षित रकम का मुफ़्त अनुमान |
| `POST /tools/upload` | `tools:execute` | स्पष्ट रूप से दिए इनपुट प्रोजेक्ट में निजी रखना |
| `POST /tools/{tool}` | `tools:execute` | शुल्क सीमा आरक्षित करके सशुल्क काम दर्ज करना |
| `GET /tools/executions` | `executions:read` | प्रोजेक्ट के निष्पादन सूचीबद्ध करना |
| `GET /tools/executions/{id}` | `executions:read` | स्थिति, नतीजे और अंतिम शुल्क लेना |
| `POST /tools/executions/{id}/cancel` | `tools:execute` | रद्द करने का अनुरोध |
| `GET /tools/executions/{id}/artifacts/{artifactId}/download` | `executions:read` | बनी फ़ाइल का अस्थायी URL लेना |

`GET /tools/executions` को `limit`, `before`, `status` और `tool` से फ़िल्टर करें। `limit` 1–100 है और डिफ़ॉल्ट 20 है।

## टूल कैटलॉग

`GET /tools` के `data` में कैटलॉग का मूल्य संस्करण, मुद्रा, निष्पादन उपलब्धता और टूल सूची है।

हर टूल में ये जानकारी है:

* `name` — निष्पादन URL और बॉडी का टूल नाम
* `description` और `category` — उपयोग और वर्ग
* `available` — आवश्यक बाहरी सेवाएँ कॉन्फ़िगर हैं और टूल उपलब्ध है या नहीं
* `inputSchema` और `example` — इनपुट JSON Schema और उदाहरण
* `models` — चुनने योग्य मॉडल, उनके उदाहरण, उपलब्धता और कीमत विवरण
* `price` — न्यूनतम शुल्क, बिलिंग इकाई और कीमत विवरण

केवल `available: true` से निष्पादन तय नहीं होता। `executionEnabled`, अनुमतियाँ, बैलेंस और मासिक सीमाएँ भी लागू हैं।

## उत्तर का प्रारूप

सफल उत्तर आम तौर पर नतीजा `data` में रखते हैं।

```json theme={null}
{
  "data": {}
}
```

त्रुटियाँ `error` में स्थिति और संदेश रखती हैं।

```json theme={null}
{
  "error": {
    "status": "PERMISSION_DENIED",
    "message": "platform_api_key_scope_required"
  }
}
```

सभी उत्तर में `Cache-Control: no-store` है। कुंजियाँ, नतीजे या अस्थायी URL साझा कैश में न रखें।

## त्रुटियाँ सँभालें

दोबारा भेजने से पहले स्थिति के अनुसार कारण जाँचें।

| HTTP | अर्थ | कदम |
| - | - | - |
| `200` | सफल प्राप्ति या वही पूरा निष्पादन | `data` प्रोसेस करें |
| `202` | असिंक्रोनस काम स्वीकार | ID रखें और कम से कम पाँच सेकंड बाद पूछें |
| `400` | अमान्य इनपुट, कोटेशन या स्थिति | कैटलॉग और कोटेशन जाँचें |
| `401` | प्रमाणीकरण विफल | Authorization, समाप्ति और रद्द होने की स्थिति जाँचें |
| `403` | अनुमति नहीं | कुंजी और प्रोजेक्ट अनुमतियाँ जाँचें |
| `404` | एंडपॉइंट, काम या आर्टिफ़ैक्ट अनुपलब्ध | पाथ, उपलब्धता और समाप्ति जाँचें |
| `409` | इडेम्पोटेंसी कुंजी दूसरे अनुरोध में इस्तेमाल | मूल बॉडी और कुंजी जाँचें; अलग निष्पादन से बचें |
| `429` | अनुरोध सीमा, बैलेंस या मासिक सीमा पूरी | संबंधित सीमा और बैलेंस जाँचें |
| `503` | निष्पादन या बाहरी सेवा अस्थायी रूप से अनुपलब्ध | पुनः प्रयास से पहले सशुल्क काम की स्वीकृति जाँचें |

## उपयोग सीमाएँ

क्लाइंट में इन सीमाओं का ध्यान रखें।

| संसाधन | सीमा |
| - | - |
| सामान्य JSON अनुरोध | UTF-8 में 64 KiB |
| अपलोड फ़ाइल | 12 MiB |
| स्वीकृत प्रकार | JPEG, PNG, WAV, MP3, MP4 |
| अनुरोध | हर API कुंजी पर स्थिर एक-मिनट की विंडो में 120 |
| स्थिति पूछने का अंतराल | कम से कम पाँच सेकंड |
| हर निष्पादन के चरण | अधिकतम 20 |
| बनी फ़ाइलों का भंडारण | 30 दिन |
| डाउनलोड URL की वैधता | अधिकतम पाँच मिनट |

कैटलॉग, कोटेशन, अपलोड, निष्पादन, स्थिति और पुनः प्रयास गिने जाते हैं। 429 से बचने के लिए अनावश्यक बार स्थिति न पूछें।

## इनपुट अपलोड करें

स्थानीय तस्वीर, ऑडियो या वीडियो के लिए MIME प्रकार और Base64 डेटा `POST /tools/upload` पर भेजें।

```json theme={null}
{
  "mimeType": "audio/wav",
  "data": "BASE64_DATA"
}
```

उत्तर में `fileId` के लिए `id`, प्रकार, आकार, SHA-256 और समाप्ति मिलते हैं। कैटलॉग के प्रारूप अनुसार `source` जैसे फ़ील्ड में दें। उसी प्रोजेक्ट में वही सामग्री समान ID देती है; पहले अपलोड से भंडारण अवधि नहीं बढ़ती।

## संबंधित पेज

प्रमाणीकरण और निष्पादन के लिए ये पेज देखें।

* [अनुरोध प्रमाणित करें](https://docs.noimosai.com/hi/developers/api/authentication.md)
* [निष्पादन और बिलिंग सँभालें](https://docs.noimosai.com/hi/developers/api/execution-and-billing.md)
* [दस्तावेज़](https://platform.noimosai.com/docs)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.