API-Referenz

Überblick

Diese Seite fasst gemeinsame Verbindungsdaten, Endpunkte, Antwortformate, Fehler und Limits der Developer-Platform-API zusammen. Toolspezifische Schemas und aktuelle Preise erhalten Sie über GET /tools.

Basis-URL und gemeinsame Header

Hängen Sie alle Pfade an diese Basis-URL an.

https://api.noimosai.com/noimosToolBridge

Authentifizieren Sie sich mit einem Developer-Platform-API-Schlüssel. Geben Sie bei JSON-Inhalten auch Content-Type an.

Authorization: Bearer nmp_...
Content-Type: application/json

Kostenpflichtige Ausführungen benötigen zusätzlich diesen Header.

Idempotency-Key: request-unique-id

Endpunkte

Die wichtigsten öffentlichen API-Endpunkte:

Methode und Pfad	Benötigte Berechtigung	Zweck
`GET /tools/project`	`project:read`	Organisation und Projekt des Schlüssels abrufen
`GET /tools/usage`	`usage:read`	Abgerechnete Anfragen und USD-Gebühren des laufenden UTC-Monats abrufen
`GET /tools`	`tools:read`	Tools, Schemas, Beispiele, Verfügbarkeit und Preise abrufen
`POST /tools/quote`	`tools:read`	Maximalen Reservierungsbetrag für die Eingabe kostenlos schätzen lassen
`POST /tools/upload`	`tools:execute`	Explizit übergebene Dateien privat im Projekt speichern
`POST /tools/{tool}`	`tools:execute`	Kostenobergrenze reservieren und kostenpflichtigen Auftrag registrieren
`GET /tools/executions`	`executions:read`	Ausführungen des Projekts auflisten
`GET /tools/executions/{id}`	`executions:read`	Status, Ergebnisse und endgültige Gebühren abrufen
`POST /tools/executions/{id}/cancel`	`tools:execute`	Abbruch anfordern
`GET /tools/executions/{id}/artifacts/{artifactId}/download`	`executions:read`	Befristete URL für eine generierte Datei abrufen

Filtern Sie GET /tools/executions mit limit, before, status und tool. limit erlaubt 1–100, Standard ist 20.

Toolkatalog

data von GET /tools enthält Preisversion, Währung, Ausführbarkeit und Toolliste für den Katalog. Jedes Tool enthält:

name — Toolname für Ausführungs-URL und Anfrageinhalt
description und category — Zweck und Kategorie
available — Ob benötigte externe Dienste konfiguriert sind und das Tool verfügbar ist
inputSchema und example — JSON Schema und Eingabebeispiel
models — Wählbare Modelle mit Beispielen, Verfügbarkeit und Preisbeschreibung pro Modell
price — Mindestgebühr, Abrechnungseinheit und Preisbeschreibung

available: true allein garantiert keine Ausführung. Auch executionEnabled des Katalogs, Schlüsselberechtigungen, Prepaid-Guthaben und monatliche Limits gelten.

Antwortformat

Erfolgreiche Antworten enthalten das Ergebnis normalerweise in data.

{
  "data": {}
}

Fehler enthalten Status und Nachricht in error.

{
  "error": {
    "status": "PERMISSION_DENIED",
    "message": "platform_api_key_scope_required"
  }
}

Alle Antworten setzen Cache-Control: no-store. Speichern Sie Schlüssel, Ergebnisse oder befristete URLs nicht in gemeinsam genutzten Caches.

Fehler behandeln

Prüfen Sie vor Wiederholung die Ursache anhand des Status.

HTTP	Bedeutung	Maßnahme
`200`	Erfolgreicher Abruf oder dieselbe abgeschlossene Ausführung	`data` verarbeiten
`202`	Asynchroner Auftrag angenommen	ID speichern und mindestens fünf Sekunden bis zur Abfrage warten
`400`	Ungültige Eingabe, Angebot oder Status	Katalog und Angebot prüfen
`401`	Authentifizierung fehlgeschlagen	Authorization, Ablauf und Widerruf prüfen
`403`	Keine Berechtigung	Schlüssel- und Projektberechtigungen prüfen
`404`	Endpunkt, Vorgang oder Artefakt nicht verfügbar	Pfad, Verfügbarkeit und Ablauf prüfen
`409`	Idempotenzschlüssel für andere Anfrage verwendet	Ursprünglichen Inhalt und Schlüssel prüfen; keine weitere Ausführung voreilig erzeugen
`429`	Anfragelimit, Guthaben oder Monatslimit erreicht	Betroffenes Limit und Guthaben prüfen
`503`	Ausführung oder externer Dienst vorübergehend nicht verfügbar	Vor Wiederholung prüfen, ob kostenpflichtiger Auftrag angenommen wurde

Nutzungslimits

Berücksichtigen Sie diese Limits im Client.

Ressource	Limit
Normale JSON-Anfrage	64 KiB in UTF-8
Hochgeladene Datei	12 MiB
Uploadformate	JPEG, PNG, WAV, MP3, MP4
Anfragen	120 pro API-Schlüssel je festem Ein-Minuten-Fenster
Statusabfrage	Frühestens alle fünf Sekunden
Schritte je Ausführung	Maximal 20
Aufbewahrung generierter Dateien	30 Tage
Download-URL	Bis zu fünf Minuten gültig

Zum Anfragelimit zählen Katalog, Angebote, Uploads, Ausführungen, Statusabfragen und Wiederholungen. Vermeiden Sie unnötig häufige Statusabfragen, um HTTP 429 vorzubeugen.

Eingabedateien hochladen

Senden Sie für lokale Bilder, Audio oder Video MIME-Typ und Base64-Daten an POST /tools/upload.

{
  "mimeType": "audio/wav",
  "data": "BASE64_DATA"
}

Bei Erfolg erhalten Sie eine als fileId nutzbare id, Format, Größe, SHA-256 und Ablaufdatum. Übergeben Sie sie in toolspezifischen Feldern wie source gemäß Katalogformat. Gleicher Inhalt im selben Projekt liefert dieselbe ID; die Aufbewahrung verlängert sich nicht über den ursprünglichen Upload hinaus.

Weiterführende Seiten

Authentifizierung und Ausführung erläutern diese Seiten.

Erste Schritte

API

CLI

MCP-Server

Überblick

Basis-URL und gemeinsame Header

Endpunkte

Toolkatalog

Antwortformat

Fehler behandeln

Nutzungslimits

Eingabedateien hochladen

Weiterführende Seiten

​Überblick

​Basis-URL und gemeinsame Header

​Endpunkte

​Toolkatalog

​Antwortformat

​Fehler behandeln

​Nutzungslimits

​Eingabedateien hochladen

​Weiterführende Seiten

Überblick

Basis-URL und gemeinsame Header

Endpunkte

Toolkatalog

Antwortformat

Fehler behandeln

Nutzungslimits

Eingabedateien hochladen

Weiterführende Seiten