API-dokumentasjon
Kall alle AI-funksjoner via din API-nøkkel, betal per bruk, integrer med få linjer kode.
Autentisering
Alle API-forespørsler må inneholde headeren Authorization.
Authorization: Bearer sk-xxxxxxxxxxxxxxxxHent din API-nøkkel på siden "API-nøkler" i konsollen. Én nøkkel per konto. Tilbakestill i konsollen; den gamle ugyldiggjøres umiddelbart.
Opprett oppgave
https://nsfwrouter.xyz/api/v1/tasks/create
Send en AI-oppgave til GPU-klyngen. Oppgaver er asynkrone og returnerer en ID. Få resultater via spørrings-API eller Webhook.
| Parameter | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| tool_id | int | Ja | Verktøy-ID, fra verktøylisten |
| params | object | Ja | Oppgaveparametere, JSON-objekt, felt avhenger av verktøy |
| webhook_url | string | Nei | Callback-URL for fullføringsmelding |
| priority | int | Nei | Oppgaveprioritet 1-10, standard 5 |
| idempotency_key | string | Nei | Idempotency-nøkkel, forhindrer duplikater |
| execution_options | object | Nei | Utførelsesalternativer, JSON-objekt |
curl -X POST https://nsfwrouter.xyz/api/v1/tasks/create \
-H "Authorization: Bearer sk-xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"tool_id": 1,
"params": {
"image": "https://example.com/photo.jpg",
"prompt": "a beautiful landscape"
},
"webhook_url": "https://your-server.com/webhook"
}'{
"code": 0,
"message": "success",
"data": {
"task": {
"id": 123,
"status": 0,
"consume_coins": 5
},
"message": "task_submitted"
}
}Saldo kontrolleres før kall. Utilstrekkelig saldo = feil insufficient_coins. Mynter trekkes ved vellykket innsending.
Spør oppgavedetaljer
https://nsfwrouter.xyz/api/v1/tasks/query
Spør detaljer og status per ID. Under behandling hentes siste status fra GPU-klyngen. Gjentatte spørringer innen 10 sekunder returnerer DB-cache uten eksterne forespørsler.
| Parameter | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| id | int | Ja | Oppgave-ID |
{
"code": 0,
"message": "success",
"data": {
"task": {
"id": 123,
"status": 1,
"task_output_json": [
{
"type": "image",
"url": "https://cdn.example.com/outputs/abc123.png",
"file_name": "abc123.png",
"file_size": 1024000,
"mime_type": "image/png",
"width": 1024,
"height": 1024
}
],
"consume_coins": 5,
"created_at": 1718200000,
"completed_at": 1718200015
}
}
}| status | Betydning |
|---|---|
| 0 | Behandler |
| 1 | Fullført |
| -1 | Avbrutt |
| -2 | Mislyktes |
Oppgaveliste
https://nsfwrouter.xyz/api/v1/tasks
Paginert spørring av gjeldende kontos oppgaver, med filtre på verktøy, status og periode.
| Parameter | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| page | int | Nei | Sidenummer, standard 1 |
| page_size | int | Nei | Sidestørrelse, standard 20, maks 50 |
| tool_id | int | Nei | Filtrer på verktøy |
| status | int | Nei | Filtrer på status (0/1/-1/-2) |
| days | int | Nei | Periode i dager, standard 30 |
{
"code": 0,
"message": "success",
"data": {
"list": [
{
"id": 123,
"tool_id": 1,
"status": 1,
"task_output_json": [
{
"type": "image",
"url": "https://cdn.example.com/outputs/abc123.png",
"file_name": "abc123.png",
"file_size": 1024000,
"mime_type": "image/png",
"width": 1024,
"height": 1024
}
],
"error": null,
"consume_coins": 5,
"created_at": 1718200000,
"completed_at": 1718200015
},
{
"id": 122,
"tool_id": 3,
"status": 0,
"task_output_json": [],
"error": null,
"consume_coins": 10,
"created_at": 1718199000,
"completed_at": 0
}
],
"page": 1,
"page_size": 20
}
}| Felt | Type | Beskrivelse |
|---|---|---|
| type | string | Resultattype: image eller video |
| url | string | CDN-URL for resultatfil |
| file_name | string | Filnavn |
| file_size | int | Filstørrelse (bytes) |
| mime_type | string | MIME-type, f.eks. image/png, video/mp4 |
| width | int | Bredde (piksler) |
| height | int | Høyde (piksler) |
Kontosaldo
https://nsfwrouter.xyz/api/v1/account/balance
Sjekk mynt-saldo, total påfylling og total forbruk for gjeldende konto.
{
"code": 0,
"message": "success",
"data": {
"remain_coins": 5000,
"total_coins": 10000,
"used_coins": 5000
}
}Webhook-callback
Hvis webhook_url angis, sendes en POST til den URL-en når oppgaven fullføres, mislykkes eller avbrytes. Body er JSON.
Content-Type: application/json
Accept: application/json
User-Agent: OpenAPI-Webhook/1.0{
"event": "task.finished",
"task": {
"id": 123,
"status": 1,
"task_output_json": [
{
"type": "image",
"url": "https://cdn.example.com/outputs/abc123.png",
"file_name": "abc123.png",
"file_size": 1024000,
"mime_type": "image/png",
"width": 1024,
"height": 1024
}
],
"consume_coins": 5,
"created_at": 1718200000,
"completed_at": 1718200015
}
}Serveren din må returnere HTTP 2xx. Ved non-2xx eller timeout (10 sek) prøver systemet igjen opptil 5 ganger med eksponentiell backoff (60s → 120s → 240s → 480s → 960s).
Feilkoder
Alle feilsvar bruker et enhetlig format: {"code": feilkode, "message": "identifikator", "data": {}}
| Feilkode | message | Beskrivelse |
|---|---|---|
| 20001 | api_key_required | API-nøkkel ikke angitt |
| 20001 | invalid_api_key | Ugyldig API-nøkkel |
| 20001 | ip_not_allowed | IP ikke på whitelist |
| 20001 | permission_denied | Tilgang nektet |
| 30001 | tool_not_found | Verktøy ikke funnet |
| 30001 | task_not_found | Oppgave ikke funnet |
| 30001 | insufficient_coins | Utilstrekkelig mynt-saldo |
| 30001 | task_submit_failed | Oppgaveinnsending mislyktes |
| 30001 | task_query_failed | Oppgavespørring mislyktes |
| 30001 | task_already_exists | Oppgave eksisterer allerede (idempotens) |
| 40001 | tool_id_required | Parameter tool_id mangler |
| 40001 | param_error | Parameterfeil |
| 40001 | webhook_url_invalid | Ugyldig webhook_url-format |
| 40001 | params_must_be_json_object_or_array | params må være et JSON-objekt eller array |
| 40001 | execution_options_must_be_json_object_or_array | execution_options må være et JSON-objekt eller array |
| Område | Kategori |
|---|---|
| 1xxxx | Systemfeil |
| 2xxxx | Autentiseringsfeil |
| 3xxxx | Forretningslogikkfeil |
| 4xxxx | Parameterfeil |
| 5xxxx | Ekstern avhengighetsfeil |