API-referens

Översikt

Den här sidan sammanfattar anslutning, ändpunkter, svar, fel och gemensamma gränser för Developer Platform API. Hämta verktygsspecifika scheman och aktuella priser med GET /tools.

Bas-URL och huvuden

Lägg till alla sökvägar efter denna bas-URL.

https://api.noimosai.com/noimosToolBridge

Autentisera med en Developer Platform-nyckel. Ange Content-Type för JSON-kroppar.

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

Betald körning kräver också detta huvud.

Idempotency-Key: request-unique-id

Ändpunkter

De viktigaste offentliga ändpunkterna:

Metod och sökväg	Behörighet	Syfte
`GET /tools/project`	`project:read`	Läsa nyckelns organisation och projekt
`GET /tools/usage`	`usage:read`	Läsa slutdebiterade anrop och avgifter för aktuell UTC-månad
`GET /tools`	`tools:read`	Hämta verktyg, scheman, exempel, tillgänglighet och priser
`POST /tools/quote`	`tools:read`	Kostnadsfritt uppskatta maxreservation för indata
`POST /tools/upload`	`tools:execute`	Lagra uttryckligen skickade indata privat i projektet
`POST /tools/{tool}`	`tools:execute`	Reservera kostnadsgräns och registrera betalt arbete
`GET /tools/executions`	`executions:read`	Lista projektets körningar
`GET /tools/executions/{id}`	`executions:read`	Hämta status, resultat och slutavgifter
`POST /tools/executions/{id}/cancel`	`tools:execute`	Begära avbrott
`GET /tools/executions/{id}/artifacts/{artifactId}/download`	`executions:read`	Hämta tidsbegränsad URL för genererad fil

Filtrera GET /tools/executions med limit, before, status och tool. limit tillåter 1–100, standard är 20.

Verktygskatalog

data från GET /tools innehåller katalogens prisversion, valuta, körningstillgänglighet och verktygslista. Varje verktyg innehåller:

name — Namn för körnings-URL och anropskropp
description och category — Syfte och klassificering
available — Om nödvändiga externa tjänster är konfigurerade och verktyget tillgängligt
inputSchema och example — JSON Schema för indata och exempel
models — Valbara modeller med exempel, tillgänglighet och prisbeskrivning per modell
price — Minimiavgift, debiteringsenhet och prisbeskrivning

Enbart available: true garanterar inte körning. Även executionEnabled, behörigheter, saldo och månadsgränser gäller.

Svarsformat

Lyckade svar placerar normalt resultatet i data.

{
  "data": {}
}

Fel innehåller status och meddelande i error.

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

Alla svar använder Cache-Control: no-store. Spara inte nycklar, resultat eller tillfälliga URL:er i delade cacheminnen.

Hantera fel

Kontrollera orsaken utifrån status före återförsök.

HTTP	Betydelse	Åtgärd
`200`	Lyckad hämtning eller samma avslutade körning	Bearbeta `data`
`202`	Asynkront arbete mottaget	Spara ID och vänta minst fem sekunder
`400`	Ogiltig indata, offert eller status	Kontrollera katalog och offert
`401`	Autentisering misslyckades	Kontrollera Authorization, giltighet och återkallelse
`403`	Behörighet saknas	Kontrollera nyckel- och projektbehörighet
`404`	Ändpunkt, åtgärd eller artefakt otillgänglig	Kontrollera sökväg, tillgänglighet och giltighet
`409`	Idempotensnyckel använd för annat anrop	Kontrollera ursprunglig kropp och nyckel; undvik ny körning
`429`	Anropsgräns, saldo eller månadsgräns nådd	Kontrollera berörd gräns och saldo
`503`	Körning eller extern tjänst tillfälligt otillgänglig	Kontrollera om betalt arbete mottagits före återförsök

Användningsgränser

Ta hänsyn till dessa gränser i klienten.

Resurs	Gräns
Vanligt JSON-anrop	64 KiB i UTF-8
Uppladdad fil	12 MiB
Filformat	JPEG, PNG, WAV, MP3, MP4
Anrop	120 per API-nyckel i varje fast enminutsfönster
Statusintervall	Minst fem sekunder
Steg per körning	Högst 20
Lagring av genererade filer	30 dagar
Giltighet för nedladdnings-URL	Upp till fem minuter

Katalog, offerter, uppladdningar, körningar, statusfrågor och återförsök räknas. Undvik onödigt täta frågor för att förebygga 429-svar.

Ladda upp indata

För lokala bilder, ljud eller video, skicka MIME-typ och Base64-data till POST /tools/upload.

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

Svaret ger ett id som används som fileId, format, storlek, SHA-256 och utgångstid. Ange det i fält som source enligt katalogen. Identiskt innehåll i samma projekt ger samma ID; lagringstiden förlängs inte från första uppladdningen.

Relaterade sidor

Dessa sidor beskriver autentisering och körning.

Kom igång

API

CLI

MCP-server

Översikt

Bas-URL och huvuden

Ändpunkter

Verktygskatalog

Svarsformat

Hantera fel

Användningsgränser

Ladda upp indata

Relaterade sidor

​Översikt

​Bas-URL och huvuden

​Ändpunkter

​Verktygskatalog

​Svarsformat

​Hantera fel

​Användningsgränser

​Ladda upp indata

​Relaterade sidor

Översikt

Bas-URL och huvuden

Ändpunkter

Verktygskatalog

Svarsformat

Hantera fel

Användningsgränser

Ladda upp indata

Relaterade sidor