API dokumentacija
API dokumentacija
Kličite vse AI funkcije preko API ključa, plačilo po uporabi, integracija v nekaj vrsticah.
Avtentikacija
Vse API zahteve morajo vsebovati glavo Authorization.
Authorization: Bearer sk-xxxxxxxxxxxxxxxxPridobite API ključ na strani „API ključi" v konzoli. En ključ na račun. Ponastavitev v konzoli; stari se takoj razveljavi.
Ustvarjanje naloge
POST
https://nsfwrouter.xyz/api/v1/tasks/create
Pošljite AI nalogo v GPU grozd. Naloge so asinhrone, vrnejo ID. Rezultati preko API ali Webhooka.
Parametri zahteve
| Parameter | Tip | Obvezno | Opis |
|---|---|---|---|
| tool_id | int | Da | ID orodja, iz seznama orodij |
| params | object | Da | Parametri naloge, JSON objekt, polja odvisna od orodja |
| webhook_url | string | Ne | URL callback za obvestilo o zaključku |
| priority | int | Ne | Prioriteta naloge 1-10, privzeto 5 |
| idempotency_key | string | Ne | Ključ idempotencije, preprečuje duplikate |
| execution_options | object | Ne | Možnosti izvedbe, JSON objekt |
Primer zahteve
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"
}'Primer odgovora
{
"code": 0,
"message": "success",
"data": {
"task": {
"id": 123,
"status": 0,
"consume_coins": 5
},
"message": "task_submitted"
}
}Stanje se preveri pred klicem. Nezadostno = napaka insufficient_coins. Kovanci se odštejejo ob uspešnem pošiljanju.
Poizvedba naloge
GET
https://nsfwrouter.xyz/api/v1/tasks/query
Poizvedba podrobnosti in statusa po ID. Med obdelavo se status vzame iz GPU grozda. Ponavljajoče poizvedbe v 10 sek vračajo DB cache.
Parametri poizvedbe
| Parameter | Tip | Obvezno | Opis |
|---|---|---|---|
| id | int | Da | ID naloge |
Primer odgovora
{
"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
}
}
}Vrednosti statusa naloge
| status | Pomen |
|---|---|
| 0 | Obdelava |
| 1 | Zaključeno |
| -1 | Preklicano |
| -2 | Neuspešno |
Seznam nalog
GET
https://nsfwrouter.xyz/api/v1/tasks
Straničen poizvedba nalog računa, s filtri na orodje, status in obdobje.
Parametri poizvedbe
| Parameter | Tip | Obvezno | Opis |
|---|---|---|---|
| page | int | Ne | Številka strani, privzeto 1 |
| page_size | int | Ne | Velikost strani, privzeto 20, max 50 |
| tool_id | int | Ne | Filtriraj po orodju |
| status | int | Ne | Filtriraj po statusu (0/1/-1/-2) |
| days | int | Ne | Obdobje v dnevih, privzeto 30 |
Primer odgovora
{
"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
}
}Opis polj task_output_json
| Polje | Tip | Opis |
|---|---|---|
| type | string | Tip rezultata: image ali video |
| url | string | CDN URL za datoteko rezultata |
| file_name | string | Ime datoteke |
| file_size | int | Velikost (bajti) |
| mime_type | string | MIME tip, npr. image/png, video/mp4 |
| width | int | Širina (piksli) |
| height | int | Višina (piksli) |
Stanje računa
GET
https://nsfwrouter.xyz/api/v1/account/balance
Preverite stanje kovancev, skupno polnjenje in skupno porabo.
Primer odgovora
{
"code": 0,
"message": "success",
"data": {
"remain_coins": 5000,
"total_coins": 10000,
"used_coins": 5000
}
}Webhook callback
Če je naveden webhook_url, se pošlje POST ob zaključku, neuspehu ali preklicu. Body je JSON.
Glave callback zahteve
Content-Type: application/json
Accept: application/json
User-Agent: OpenAPI-Webhook/1.0Body callback zahteve
{
"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
}
}Vaš strežnik mora vrniti HTTP 2xx. Pri non-2xx ali timeout (10 sek), sistem poskusi do 5-krat z eksponentnim backoffom.
Kode napak
Vsi odgovori napak uporabljajo format: {"code": koda, "message": "identifikator", "data": {}}
| Koda napake | message | Opis |
|---|---|---|
| 20001 | api_key_required | API ključ ni naveden |
| 20001 | invalid_api_key | Neveljaven API ključ |
| 20001 | ip_not_allowed | IP ni na whitelistu |
| 20001 | permission_denied | Dostop zavrnjen |
| 30001 | tool_not_found | Orodje ni najdeno |
| 30001 | task_not_found | Naloga ni najdena |
| 30001 | insufficient_coins | Nezadostno kovancev |
| 30001 | task_submit_failed | Pošiljanje naloge neuspešno |
| 30001 | task_query_failed | Poizvedba naloge neuspešna |
| 30001 | task_already_exists | Naloga že obstaja (idempotency) |
| 40001 | tool_id_required | Parameter tool_id manjka |
| 40001 | param_error | Napaka parametrov |
| 40001 | webhook_url_invalid | Neveljaven format webhook_url |
| 40001 | params_must_be_json_object_or_array | params mora biti JSON objekt ali polje |
| 40001 | execution_options_must_be_json_object_or_array | execution_options mora biti JSON objekt ali polje |
Obsegi kod napak
| Obseg | Kategorija |
|---|---|
| 1xxxx | Sistemska napaka |
| 2xxxx | Napaka avtentikacije |
| 3xxxx | Napaka poslovne logike |
| 4xxxx | Napaka parametrov |
| 5xxxx | Napaka zunanje odvisnosti |