> ## 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.

# Dokumentacja API

> Bazowy URL, endpointy, odpowiedzi, błędy i limity użycia.

## Przegląd

Ta strona podsumowuje połączenie, endpointy, odpowiedzi, błędy i wspólne limity API Developer Platform. Schematy i aktualne ceny narzędzi pobieraj przez `GET /tools`.

## Bazowy URL i nagłówki

Dodawaj wszystkie ścieżki do tego bazowego URL.

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

Uwierzytelniaj kluczem Developer Platform. Dla korpusu JSON dodaj Content-Type.

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

Płatne wykonanie wymaga też tego nagłówka.

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

## Endpointy

Główne endpointy publicznego API:

| Metoda i ścieżka | Wymagane uprawnienie | Zastosowanie |
| - | - | - |
| `GET /tools/project` | `project:read` | Odczyt organizacji i projektu klucza |
| `GET /tools/usage` | `usage:read` | Odczyt rozliczonych żądań i opłat bieżącego miesiąca UTC |
| `GET /tools` | `tools:read` | Pobranie narzędzi, schematów, przykładów, dostępności i cen |
| `POST /tools/quote` | `tools:read` | Bezpłatna wycena maksymalnej rezerwacji dla wejścia |
| `POST /tools/upload` | `tools:execute` | Prywatny zapis jawnie przesłanych danych w projekcie |
| `POST /tools/{tool}` | `tools:execute` | Rezerwacja limitu i rejestracja płatnego zadania |
| `GET /tools/executions` | `executions:read` | Lista wykonań projektu |
| `GET /tools/executions/{id}` | `executions:read` | Pobranie stanu, wyników i końcowych opłat |
| `POST /tools/executions/{id}/cancel` | `tools:execute` | Żądanie anulowania |
| `GET /tools/executions/{id}/artifacts/{artifactId}/download` | `executions:read` | Pobranie tymczasowego URL wygenerowanego pliku |

Filtruj `GET /tools/executions` przez `limit`, `before`, `status` i `tool`. `limit` przyjmuje 1–100, domyślnie 20.

## Katalog narzędzi

`data` z `GET /tools` zawiera wersję cen, walutę, dostępność wykonania i listę narzędzi katalogu.

Każde narzędzie podaje:

* `name` — Nazwa używana w URL wykonania i korpusie
* `description` i `category` — Cel i klasyfikacja
* `available` — Czy potrzebne usługi zewnętrzne są skonfigurowane i narzędzie dostępne
* `inputSchema` i `example` — JSON Schema wejścia i przykład
* `models` — Dostępne modele z przykładami, dostępnością i opisem cen
* `price` — Minimalna opłata, jednostka rozliczeń i opis cen

Samo `available: true` nie gwarantuje wykonania. Obowiązują też `executionEnabled`, uprawnienia, saldo i limity miesięczne.

## Format odpowiedzi

Pomyślne odpowiedzi zwykle umieszczają wynik w `data`.

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

Błędy zawierają status i wiadomość w `error`.

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

Wszystkie odpowiedzi mają `Cache-Control: no-store`. Nie zapisuj kluczy, wyników ani tymczasowych URL we współdzielonych pamięciach podręcznych.

## Obsługa błędów

Przed ponowieniem sprawdź przyczynę według statusu.

| HTTP | Znaczenie | Działanie |
| - | - | - |
| `200` | Pomyślny odczyt lub to samo zakończone wykonanie | Przetwórz `data` |
| `202` | Przyjęto zadanie asynchroniczne | Zapisz ID i odczekaj co najmniej pięć sekund |
| `400` | Nieprawidłowe wejście, wycena lub stan | Sprawdź katalog i wycenę |
| `401` | Błąd uwierzytelniania | Sprawdź Authorization, ważność i unieważnienie |
| `403` | Brak uprawnień | Sprawdź uprawnienia klucza i projektu |
| `404` | Endpoint, operacja lub artefakt niedostępny | Sprawdź ścieżkę, dostępność i termin |
| `409` | Klucz idempotencji użyty do innego żądania | Sprawdź pierwotny korpus i klucz; unikaj kolejnego wykonania |
| `429` | Osiągnięto limit żądań, saldo lub limit miesięczny | Sprawdź właściwy limit i saldo |
| `503` | Wykonanie lub usługa tymczasowo niedostępna | Przed ponowieniem sprawdź przyjęcie płatnego zadania |

## Limity użycia

Uwzględnij te limity w kliencie.

| Zasób | Limit |
| - | - |
| Zwykłe żądanie JSON | 64 KiB w UTF-8 |
| Przesłany plik | 12 MiB |
| Formaty plików | JPEG, PNG, WAV, MP3, MP4 |
| Żądania | 120 na klucz API w stałym jednominutowym oknie |
| Odstęp odpytywania | Co najmniej pięć sekund |
| Kroki wykonania | Maksymalnie 20 |
| Przechowywanie wygenerowanych plików | 30 dni |
| Ważność URL pobierania | Do pięciu minut |

Liczą się katalog, wyceny, przesyłanie, wykonania, odpytywanie i ponowienia. Unikaj nadmiernego odpytywania, aby zapobiec odpowiedziom 429.

## Przesyłanie danych wejściowych

Dla lokalnych obrazów, dźwięku lub wideo wyślij typ MIME i dane Base64 do `POST /tools/upload`.

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

Odpowiedź zwraca `id` używane jako `fileId`, format, rozmiar, SHA-256 i termin wygaśnięcia. Podaj je w polach takich jak `source` zgodnie z katalogiem. Identyczna treść w tym samym projekcie zwraca ten sam ID; termin nie wydłuża się od pierwszego przesłania.

## Powiązane strony

Te strony opisują uwierzytelnianie i wykonanie.

* [Uwierzytelnianie żądań](https://docs.noimosai.com/pl/developers/api/authentication.md)
* [Wykonania i rozliczenia](https://docs.noimosai.com/pl/developers/api/execution-and-billing.md)
* [Dokumentacja](https://platform.noimosai.com/docs)


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