API-dokumentation
Kald alle AI-funktioner via din API-nøgle, betal pr. brug, integrer med få linjer kode.
Autentificering
Alle API-anmodninger skal indeholde headeren Authorization.
Authorization: Bearer sk-xxxxxxxxxxxxxxxxHent din API-nøgle på siden "API-nøgler" i konsollen. Én nøgle pr. konto. Nulstil i konsollen; den gamle ugyldiggøres straks.
Opret opgave
https://nsfwrouter.xyz/api/v1/tasks/create
Send en AI-opgave til GPU-klyngen. Opgaver er asynkrone og returnerer et ID. Få resultater via forespørgsels-API eller Webhook.
| Parameter | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| tool_id | int | Ja | Værktøjs-ID, fra værktøjslisten |
| params | object | Ja | Opgaveparametre, JSON-objekt, felter afhænger af værktøj |
| webhook_url | string | Nej | Callback-URL til meddelelse om fuldførelse |
| priority | int | Nej | Opgaveprioritet 1-10, standard 5 |
| idempotency_key | string | Nej | Idempotency-nøgle, forhindrer dubletter |
| execution_options | object | Nej | Udførelsesindstillinger, 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 kald. Utilstrækkelig saldo = fejl insufficient_coins. Mønter trækkes ved succesfuld indsendelse.
Forespørg opgavedetaljer
https://nsfwrouter.xyz/api/v1/tasks/query
Forespørg detaljer og status pr. ID. Under behandling hentes seneste status fra GPU-klyngen. Gentagne forespørgsler inden for 10 sekunder returnerer DB-cache uden fjernanmodninger.
| Parameter | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| id | int | Ja | Opgave-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 | Fuldført |
| -1 | Annulleret |
| -2 | Mislykkedes |
Opgaveliste
https://nsfwrouter.xyz/api/v1/tasks
Pagineret forespørgsel af aktuelle kontos opgaver, med filtre på værktøj, status og periode.
| Parameter | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| page | int | Nej | Sidenummer, standard 1 |
| page_size | int | Nej | Sidestørrelse, standard 20, max 50 |
| tool_id | int | Nej | Filtrer på værktøj |
| status | int | Nej | Filtrer på status (0/1/-1/-2) |
| days | int | Nej | Periode i dage, 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 (pixels) |
| height | int | Højde (pixels) |
Kontosaldo
https://nsfwrouter.xyz/api/v1/account/balance
Tjek mønt-saldo, total opkrævning og total forbrug for aktuelle konto.
{
"code": 0,
"message": "success",
"data": {
"remain_coins": 5000,
"total_coins": 10000,
"used_coins": 5000
}
}Webhook-callback
Hvis webhook_url angives, sendes en POST til den URL når opgaven fuldføres, mislykkes eller annulleres. 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
}
}Din server skal returnere HTTP 2xx. Ved non-2xx eller timeout (10 sek) forsøger systemet igen op til 5 gange med eksponentiel backoff (60s → 120s → 240s → 480s → 960s).
Fejlkoder
Alle fejlreaktioner bruger et enhedligt format: {"code": fejlkode, "message": "identifikator", "data": {}}
| Fejlkode | message | Beskrivelse |
|---|---|---|
| 20001 | api_key_required | API-nøgle ikke angivet |
| 20001 | invalid_api_key | Ugyldig API-nøgle |
| 20001 | ip_not_allowed | IP ikke på whitelist |
| 20001 | permission_denied | Adgang nægtet |
| 30001 | tool_not_found | Værktøj ikke fundet |
| 30001 | task_not_found | Opgave ikke fundet |
| 30001 | insufficient_coins | Utilstrækkelig mønt-saldo |
| 30001 | task_submit_failed | Opgaveindsendelse mislykkedes |
| 30001 | task_query_failed | Opgaveforespørgsel mislykkedes |
| 30001 | task_already_exists | Opgave eksisterer allerede (idempotens) |
| 40001 | tool_id_required | Parameter tool_id mangler |
| 40001 | param_error | Parameterfejl |
| 40001 | webhook_url_invalid | Ugyldigt webhook_url-format |
| 40001 | params_must_be_json_object_or_array | params skal være et JSON-objekt eller array |
| 40001 | execution_options_must_be_json_object_or_array | execution_options skal være et JSON-objekt eller array |
| Interval | Kategori |
|---|---|
| 1xxxx | Systemfejl |
| 2xxxx | Autentificeringsfejl |
| 3xxxx | Forretningslogikfejl |
| 4xxxx | Parameterfejl |
| 5xxxx | Ekstern afhængighedsfejl |