API
Optimize YDR, YDD, YFT and YTD files, and pull every build of your clothing packs, from a script or a CI job.
Max planv1JSON over HTTPSNever costs creditsChaves em /app/api
https://zoov.dev/api/public/v1 Nesta página
Two hosts
Each file takes two calls. The first goes to zoov.dev with your key and the file's name and size; it checks the plan, opens a run and answers an upload link. The second sends the file to that link on the conversion box, which answers with the optimized file.
/api/public/v1 Checks the key, the plan and the size. Opens the run.zv_ key Two calls per file.upload.url Optimizes the file. One upload per link.Authentication
Send your key on every call to zoov.dev as Authorization: Bearer zv_…. Make keys at /app/api; only a hash is kept, so a lost key is revoked and replaced. The upload link carries its own one-time ticket and takes no header.
Keys work from servers and CI, never from a browser page: anyone who opens the page can read it. Keep the key in an environment variable such as ZOOV_KEY.
curl https://zoov.dev/api/public/v1/me \
-H "Authorization: Bearer $ZOOV_KEY"Optimize a folder
Every YDR, YDD, YFT and YTD in a folder, as many at once as the plan allows, written to a second folder. A file whose original was the better one is left out of the second folder. Run as it is with your key in ZOOV_KEY.
#!/usr/bin/env bash
# ./optimize.sh ./stream ./optimized (curl and jq, ZOOV_KEY in the environment)
API=https://zoov.dev/api/public/v1
src=${1:-./stream}; out=${2:-./optimized}; mkdir -p "$out"
for f in "$src"/*.{ydr,ydd,yft,ytd}; do
[ -e "$f" ] || continue
name=$(basename "$f")
run=$(curl -s "$API/optimize" -H "Authorization: Bearer $ZOOV_KEY" \
-H "Content-Type: application/json" \
-d "{\"name\":\"$name\",\"bytes\":$(wc -c < "$f")}")
url=$(jq -r '.upload.url // empty' <<< "$run")
[ -n "$url" ] || { echo "$name: $(jq -r .error <<< "$run")"; continue; }
type=$(curl -s "$url" -F "file=@$f" -o "$out/$name" -w '%{content_type}')
case "$type" in
*json*) echo "$name: kept the original"; rm "$out/$name" ;;
*) echo "$name: done" ;;
esac
doneCheck the key
GET /me
Who the key belongs to, the plan, the credit balance and the Optimize allowance. optimize.concurrent is how many uploads a script should keep in flight; maxFileBytes is the largest file.
curl https://zoov.dev/api/public/v1/me \
-H "Authorization: Bearer $ZOOV_KEY"{
"account": {
"id": "11111111-2222-4333-8444-555555555555",
"name": "Your account"
},
"plan": "max",
"key": {
"id": "66666666-7777-4888-9999-aaaaaaaaaaaa",
"scopes": [
"*"
],
"requestsPerMinute": 300
},
"credits": {
"balance": 12480,
"permanent": 0,
"temporary": 12480
},
"optimize": {
"perDay": null,
"used": 0,
"active": 0,
"concurrent": 5,
"maxFileBytes": 104857600,
"resetAt": null
}
}Start an optimize
POST /optimize
Checks the plan, the size and how many files are running, opens a run and answers 201 with the run and where to send the file. The link takes one upload and lapses at run.expiresAt, 15 minutes on. Ask for it when the file is ready: a waiting run holds one of the plan's five slots.
namestring obrigatório- The file name, ending in .ydr, .ydd, .yft or .ytd. The upload must carry a file of the same type.
bytesinteger obrigatório- The file size. Checked against the plan before anything is uploaded.
kindstring- ydr, ydd, yft or ytd. Only for a name without an extension.
curl https://zoov.dev/api/public/v1/optimize \
-H "Authorization: Bearer $ZOOV_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"prop_crate.ydr","bytes":989341}'{
"run": {
"id": "84862bbf-c87d-4320-95f8-d00659d32f60",
"state": "waiting",
"name": "prop_crate.ydr",
"kind": "ydr",
"maxBytes": 104857600,
"expiresAt": "2026-10-01T12:11:45.000Z"
},
"upload": {
"method": "POST",
"url": "https://v2.winapi.zoov.dev/public/v1/optimize/zt_eyJ2IjoxLCJ1c2Ui…",
"contentType": "multipart/form-data",
"fields": {
"file": "the file",
"settings": "optional, JSON"
}
}
}Send the file
POST upload.url
A multipart POST to the link from the last call, on the conversion box, with no header. Two answers are a success:
application/octet-stream: the optimized file, with the result as JSON inX-Optimize-Result.application/json:{ result }withresult.keptset. The original was the better file; keep yours.
filefile obrigatório- The resource, up to 100 MB, of the type the run was opened for.
settingsJSON string- What to change. Leave it out for the defaults; see Settings.
curl "$UPLOAD_URL" \
-F file=@prop_crate.ydr \
-F 'settings={"textures":{"maxSize":1024}}' \
-D headers.txt \
-o prop_crate.optimized.ydrHTTP/1.1 200 OK
content-type: application/octet-stream
content-disposition: attachment; filename="prop_crate.ydr"
content-length: 972633
x-optimize-result: {"kind":"ydr","gameVersion":"gen8","bytesIn":989341,"bytesOut":972633,"outcome":"smaller","kept":null,"textures":{"count":7,"changed":1,"resized":0,"recompressed":1,"failed":0,"dropped":0,"list":[{"name":"dt1_13_build2_pal","from":[256,4,"A8R8G8B8"],"to":[256,4,"DXT5"]}],"more":0},"meshes":null,"warnings":[],"notes":[],"durations":{"textures":1052},"settings":{…},"name":"prop_crate.ydr"}
<972,633 bytes of the optimized file>{
"result": {
"kind": "ydr",
"gameVersion": "gen8",
"bytesIn": 788596,
"bytesOut": 484775,
"outcome": "smaller",
"kept": "nothing_to_do",
"textures": {
"count": 7,
"changed": 0,
"resized": 0,
"recompressed": 0,
"failed": 0,
"dropped": 0,
"list": [],
"more": 0
},
"meshes": null,
"warnings": [],
"notes": [],
"durations": {
"textures": 32
},
"settings": {
"textures": {
"enabled": true,
"maxSize": 1024,
"forceSize": false,
"format": "auto",
"mips": true
},
"meshes": {
"enabled": false,
"detail": 1,
"lods": true
},
"keepSmaller": true
},
"name": "prop_bench.ydr"
}
}Read a run
GET /optimize/:id
What the ledger knows about one run. For a script that lost the upload's answer and needs to know whether the file went through.
statestring- waiting (no upload yet), running, done (a file was delivered), kept (the original was the better file), failed, expired (no upload within 15 minutes).
bytesIn · bytesOutinteger- Sizes before and after. bytesOut is null until the box has answered.
outcomestring- smaller, larger or same — the file on disk. What decides delivery is the game: memory, LODs, triangles.
codestring- Why a file was kept (nothing_to_do, not_lighter, would_drop_textures) or why it failed (cancelled, timeout, encrypted...).
msinteger- Time the box spent on the file.
curl https://zoov.dev/api/public/v1/optimize/$RUN_ID \
-H "Authorization: Bearer $ZOOV_KEY"{
"run": {
"id": "84862bbf-c87d-4320-95f8-d00659d32f60",
"state": "done",
"name": "prop_crate.ydr",
"kind": "ydr",
"bytesIn": 989341,
"bytesOut": 972633,
"outcome": "smaller",
"code": null,
"ms": 1412,
"createdAt": "2026-10-01T11:56:44.901862+00:00",
"finishedAt": "2026-10-01T11:56:46.638903+00:00"
}
}Cancel a run
DELETE /optimize/:id
Gives back a run whose file will not be sent, so its slot frees now instead of after 15 minutes. Answers 409 in_progress once the box has the file.
curl -X DELETE https://zoov.dev/api/public/v1/optimize/$RUN_ID \
-H "Authorization: Bearer $ZOOV_KEY"{
"run": {
"id": "bf2b34ed-b5f0-40b7-bd0c-52b528450715",
"state": "failed",
"name": "later.ytd",
"kind": "ytd",
"bytesIn": 541242,
"bytesOut": null,
"outcome": null,
"code": "cancelled",
"ms": null,
"createdAt": "2026-10-01T11:56:51.348156+00:00",
"finishedAt": "2026-10-01T11:56:52.943315+00:00"
}
}Settings
The settings field of the upload, as JSON; the same settings as the Optimize tool in the workspace. Send only what differs from the defaults. The defaults shrink a file without touching a vertex.
textures.enabledboolean · true- Recompress and resize textures. Every file type.
textures.maxSize256 to 4096 · 1024- The longest side a texture keeps; larger ones are scaled down. 256, 512, 1024, 2048 or 4096.
textures.forceSizeboolean · false- Scale every texture to maxSize, smaller ones too.
textures.formatstring · auto- auto only ever moves a texture to a lighter format. dxt1, dxt5 or bc7 force one.
textures.mipsboolean · true- Rebuild mipmaps.
textures.neutralizeBlacksboolean · false- Dark almost-grey pixels made exactly grey before the re-encode, so DXT gives dark areas no green or purple cast.
meshes.enabledboolean · false- Work on geometry. YDR, YDD and YFT only.
meshes.detail0.4 to 1 · 1- The share of triangles kept.
meshes.lodsboolean · true- Add missing LODs. A file that gains LODs can grow and is still delivered.
meshes.rebuildLodsboolean · false- Make every lower LOD again from the high one, replacing the ones in the file.
keepSmallerboolean · true- Answer with JSON instead of a file when the new file is no lighter for the game (textures loaded, LODs, triangles); the name is from when the file on disk decided.
The result
The object in X-Optimize-Result, or in result when the original was kept.
kind · namestring- The file type and the name it was sent with.
bytesIn · bytesOutinteger- Sizes on disk before and after the rebuild.
memoryobject- What the textures cost loaded, before and after, in bytes; null when no texture pass ran. lighter says whether they cost less.
outcomestring- smaller, larger or same — the file on disk. What decides delivery is the game: memory, LODs, triangles.
keptstring or null- null when the file was delivered. nothing_to_do: nothing needed changing, so the original is kept even when the rebuild came out a little smaller. not_smaller: the new file was no smaller. would_drop_textures: textures without readable mipmaps would have been lost.
texturesobject- count, changed, resized, recompressed, failed, dropped, and list: each changed texture with its size and format before and after (the first few; more counts the rest).
meshesobject or null- When geometry ran: trianglesBefore, trianglesAfter, lodsAdded, lodsKept.
warningsstring[]- meshes_skipped, no_textures, textures_dropped, textures_failed, high_kept, hi_fragment, drawables_skipped, over_budget (the file is over 16 MB).
durations · settingsobject- Milliseconds per stage, and the settings as applied.
Errors
Branch on code, never on the message. zoov.dev answers { error, code } with the facts beside them; the conversion box answers { detail: { code, error, retryable } }.
A refusal about the file itself (type, size, empty, unreadable header) leaves the link usable for the right file. Once the box has started work, a failure closes the run: ask for a new link to try again.
{
"error": "File is larger than this plan allows",
"code": "file_too_large",
"maxBytes": 104857600,
"tier": "max"
}{
"detail": {
"code": "ticket_used",
"error": "This upload link was used already or has expired",
"retryable": false
}
}zoov.dev/api/public/v1
401
unauthorizedThe key is missing, mistyped, revoked or expired.
403
plan_requiredThe account is not on Max.
403
scope_missingThe key has scopes, and optimize is not one of them.
403
account_suspendedThe account is suspended.
404
not_foundNo run with that id on this account.
409
concurrency_limitFive files are running already, in the workspace or here. Wait for one and ask again.
409
in_progressDELETE after the box took the file.
413
file_too_largeOver the plan’s size. maxBytes says the limit.
429
rate_limitedOver 300 calls a minute for this key. retryAfter says when.
503
unavailableOptimize is down for a moment. Try again.
The uploadupload.url
400
wrong_kindThe file is not the type the run was opened for. The link still takes the right file.
400
empty · settingsAn empty file, or settings that are not valid JSON for this shape.
401
ticket_invalid · ticket_expiredThe link was altered or is past 15 minutes. Ask for a new one.
409
ticket_usedThe link took a file already. One upload per link.
413
too_large · too_complexOver 100 MB, or a part with more than 32,767 vertices.
415
unsupportedNot a YDR, YDD, YFT or YTD.
422
not_resource · encryptedNot a GTA V resource, or an escrow-protected one. These cannot be read.
422
legacy_names · unnamed_textures · no_geometry · crashThe file could not be worked on as it is.
503
busy · texture_tool · site_unavailableretryable: true. Ask for a new link and send the file again.
504
timeoutTook too long and was stopped. retryable: true.
Limits
- 5 files at once
- Shared with the Optimize tool in the workspace. A waiting link holds a slot until its file is done, it is cancelled or 15 minutes pass.
- 100 MB per file
- Checked when the run opens and again on upload.
- No daily cap
- Optimize never costs credits.
- 300 calls a minute
- Per key, on zoov.dev. Uploads count on the box: 300 a minute per address.
- One upload per link
- Each link lasts 15 minutes.
- 10 keys
- Active keys per account.
Packs API
Every numbered build of a pack kept in the cloud is a list of files: each path inside the resource folder with the SHA-256 and size of its bytes. Read the list, compare the hashes with what your server or repository holds, and download only what changed. A build that renumbers items renames files without changing their bytes, so it costs no downloads at all.
The same key and base address, scope packs:read. A key reads every pack its account is in, shared packs too. Builds are kept as the plan keeps them (the newest 100 on Max; named ones stay), and latest is always the newest. A build becomes readable a moment after it is made in the app, once its files are in the cloud copy.
Pull a build
The latest build into a folder, for a server, a CI job or a repository. It keeps .zoov-build.json in the folder, the same record the app’s Build into a folder writes, so it removes only files it wrote itself and leaves everything else alone. Run it again after every build, or from a webhook.
#!/usr/bin/env bash
# ./pull.sh <pack id> ./resources/[clothing]/mypack (curl, jq and sha256sum, ZOOV_KEY in the environment)
# The latest build of a pack into a folder; only files whose hash changed are downloaded.
API=https://zoov.dev/api/public/v1
pack=$1; dir=${2:-.}; mkdir -p "$dir"
auth="Authorization: Bearer $ZOOV_KEY"
record="$dir/.zoov-build.json"; [ -f "$record" ] || echo '{"files":{}}' > "$record"
curl -sf "$API/packs/$pack/builds/latest/manifest" -H "$auth" > manifest.json
jq -c --slurpfile old "$record" '.files[] | select($old[0].files[.path] != .sha256)' manifest.json > changed.jsonl
split -l 500 changed.jsonl part. 2>/dev/null
for part in part.*; do
[ -s "$part" ] || continue
urls=$(jq -s '{sha256: [.[].sha256] | unique}' "$part" | curl -sf "$API/packs/$pack/files" -H "$auth" -H "Content-Type: application/json" -d @-)
while read -r f; do
path=$(jq -r .path <<< "$f"); sha=$(jq -r .sha256 <<< "$f")
mkdir -p "$dir/$(dirname "$path")"
curl -sf "$(jq -r --arg s "$sha" '.urls[$s]' <<< "$urls")" -o "$dir/$path"
echo "$sha $dir/$path" | sha256sum -c --quiet || exit 1
done < "$part"
done
jq -r --slurpfile new manifest.json '.files | keys[] | select(. as $p | $new[0].files | map(.path) | index($p) | not)' "$record" |
while read -r gone; do rm -f "$dir/$gone"; done
jq '{version: 1, release, files: (.files | map({(.path): .sha256}) | add)}' manifest.json > "$record"
echo "v$(jq .release manifest.json): $(wc -l < changed.jsonl) files changed"
rm -f manifest.json changed.jsonl part.*List packs
GET /packs
The packs the account is in, newest first, each with the role you have in it and its latest build in the cloud. A pack kept only on one device is not here: it needs its cloud copy.
curl https://zoov.dev/api/public/v1/packs \
-H "Authorization: Bearer $ZOOV_KEY"{
"packs": [
{
"id": "p7k2m9x4q1w8e5r3",
"name": "Harbour Winter",
"role": "owner",
"items": 1153,
"updatedAt": "2026-10-02T18:40:11.204Z",
"latest": { "release": 5, "createdAt": "2026-10-02T18:39:52.913Z" }
}
]
}List builds
GET /packs/:id/builds
The kept builds, newest first. ?limit= takes up to 200.
releaseinteger- The build number, v5 in the app; the same number is in the resource’s fxmanifest.lua as version.
slugstring- The resource folder’s name.
editionstring- legacy (stream/) or enhanced (stream_enhanced/, every model and texture in Gen9).
files · bytesinteger- What the resource holds.
notestring or null- What its author wrote for the build.
countsobject- Items added, changed and removed since the build before, as players see them.
changelogstring or null- Only on one build: the players’ changelog as Discord Markdown.
curl https://zoov.dev/api/public/v1/packs/p7k2m9x4q1w8e5r3/builds \
-H "Authorization: Bearer $ZOOV_KEY"{
"builds": [
{
"id": "6c1e0f7a-2b9d-4f3e-8a51-3d0c9b7e2f14",
"release": 5,
"slug": "harbour_winter",
"edition": "legacy",
"files": 6942,
"bytes": 1897123456,
"note": "Winter coats and two new hats",
"counts": { "added": 12, "changed": 3, "removed": 1 },
"version": 41,
"createdAt": "2026-10-02T18:39:52.913Z"
}
]
}Read a build
GET /packs/:id/builds/:release
One build by number (5 or v5) or latest, with its changelog: what players see changed, in the words the app copies to Discord.
curl https://zoov.dev/api/public/v1/packs/p7k2m9x4q1w8e5r3/builds/latest \
-H "Authorization: Bearer $ZOOV_KEY"{
"id": "6c1e0f7a-2b9d-4f3e-8a51-3d0c9b7e2f14",
"release": 5,
"slug": "harbour_winter",
"edition": "legacy",
"files": 6942,
"bytes": 1897123456,
"note": "Winter coats and two new hats",
"counts": { "added": 12, "changed": 3, "removed": 1 },
"version": 41,
"createdAt": "2026-10-02T18:39:52.913Z",
"changelog": "**Added · 12**\n- Male Top 214 · Harbour parka · 4 colours\n…"
}Read its files
GET /packs/:id/builds/:release/manifest
Every file of the build. The same build always answers the same list; its ETag is the build’s id, so If-None-Match answers 304 until a new build is the latest.
resourcestring- The resource folder’s name. Paths are inside it.
files[].pathstring- Forward slashes, inside the resource folder, never .. or absolute.
files[].sha256string- SHA-256 of the file’s bytes. Compare with what you have; download only what differs.
files[].bytesinteger- The file’s size.
curl https://zoov.dev/api/public/v1/packs/p7k2m9x4q1w8e5r3/builds/latest/manifest \
-H "Authorization: Bearer $ZOOV_KEY"{
"pack": "p7k2m9x4q1w8e5r3",
"resource": "harbour_winter",
"release": 5,
"edition": "legacy",
"createdAt": "2026-10-02T18:39:52.913Z",
"files": [
{ "path": "fxmanifest.lua", "sha256": "0b7d…", "bytes": 412 },
{ "path": "mp_m_freemode_01_mp_m_harbour_winter.meta", "sha256": "5e1a…", "bytes": 1840221 },
{ "path": "stream/mp_m_freemode_01_mp_m_harbour_winter.ymt", "sha256": "c8f0…", "bytes": 412088 },
{ "path": "stream/mp_m_freemode_01_mp_m_harbour_winter/mp_m_freemode_01_mp_m_harbour_winter^jbib_214_u.ydd", "sha256": "9f2c…", "bytes": 331776 },
{ "path": "stream/mp_m_freemode_01_mp_m_harbour_winter/mp_m_freemode_01_mp_m_harbour_winter^jbib_diff_214_a_uni.ytd", "sha256": "41ab…", "bytes": 143360 }
],
"bytes": 1897123456,
"note": "Winter coats and two new hats"
}Download files
POST /packs/:id/files
Download addresses for up to 500 hashes a call, each good for an hour, straight from storage with no header. A hash no kept build names is left out of the answer. Check each download against its hash.
curl https://zoov.dev/api/public/v1/packs/p7k2m9x4q1w8e5r3/files \
-H "Authorization: Bearer $ZOOV_KEY" \
-H "Content-Type: application/json" \
-d '{"sha256":["9f2c…","41ab…"]}'{
"urls": {
"9f2c…": "https://db.zoov.dev/storage/v1/object/sign/workspace/packs/p7k2m9x4q1w8e5r3/o/9f2c…?token=…",
"41ab…": "https://db.zoov.dev/storage/v1/object/sign/workspace/packs/p7k2m9x4q1w8e5r3/o/41ab…?token=…"
},
"expiresIn": 3600
}Hear about builds
POST /webhooks
Your endpoint gets build.published when a build is in the cloud, as a POST of JSON signed the Standard Webhooks way: webhook-id, webhook-timestamp and webhook-signature, keyed by the secret this call answers once (scope webhooks). Answer any 2xx within ten seconds. Anything else is tried again after 1, 5 and 30 minutes, 2, 6 and 12 hours; webhook-id stays the same, so a retry can be told from a new build.
urlstring obrigatório- An https:// address on the public internet.
packIdstring or null- One pack, or null for every pack the account is in, shared ones too.
eventsstring[]- build.published, the default and for now the only one.
descriptionstring- A name for yourself, 200 characters at most.
The delivery
data.links.manifest is the build’s file list on this API. replaced is true when the build took the place of another of the same number.
{
"type": "build.published",
"timestamp": "2026-10-02T18:39:53.402Z",
"data": {
"pack": { "id": "p7k2m9x4q1w8e5r3", "name": "Harbour Winter" },
"build": {
"release": 5,
"edition": "legacy",
"resource": "harbour_winter",
"files": 6942,
"bytes": 1897123456,
"note": "Winter coats and two new hats",
"counts": { "added": 12, "changed": 3, "removed": 1 },
"createdAt": "2026-10-02T18:39:52.913Z",
"replaced": false
},
"links": {
"manifest": "https://zoov.dev/api/public/v1/packs/p7k2m9x4q1w8e5r3/builds/5/manifest",
"app": "https://zoov.dev/app/packs/p7k2m9x4q1w8e5r3"
}
}
}Check the signature
// Check a delivery before trusting it (Standard Webhooks: any of their libraries does the same).
import { createHmac, timingSafeEqual } from 'node:crypto';
export function verify(headers, rawBody, secret = process.env.ZOOV_WEBHOOK_SECRET) {
const id = headers['webhook-id'];
const ts = Number(headers['webhook-timestamp']);
if (Math.abs(Date.now() / 1000 - ts) > 300) return false; // older than five minutes: a replay
const key = Buffer.from(secret.replace(/^whsec_/, ''), 'base64');
const want = createHmac('sha256', key).update(`${id}.${ts}.${rawBody}`).digest();
return headers['webhook-signature'].split(' ').some((sig) => {
const got = Buffer.from(sig.replace(/^v1,/, ''), 'base64');
return got.length === want.length && timingSafeEqual(got, want);
});
}The other calls
GET /webhooksJSON- The account’s webhooks, with each one’s last answer.
PATCH /webhooks/:idJSON- url, events, active or description. active: true switches back on a hook that failed 50 times in a row.
POST /webhooks/:id/testJSON- Sends a ping now and answers how your endpoint answered.
DELETE /webhooks/:id- Deliveries stop at once.
The same webhooks are on /app/api, with each one’s signing secret and a Send test.
curl https://zoov.dev/api/public/v1/webhooks \
-H "Authorization: Bearer $ZOOV_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/zoov","packId":null}'{
"id": "a4d2c8e1-7f30-4b6a-9e15-2c8b7d0f3a91",
"url": "https://example.com/zoov",
"events": ["build.published"],
"packId": null,
"description": null,
"active": true,
"failures": 0,
"last": { "status": null, "error": null, "at": null },
"createdAt": "2026-10-02T18:44:03.117Z",
"secret": "whsec_X5f0…"
}Errors
The same { error, code } shape as the rest of the API. A download address that lapsed answers storage’s own 400: ask /files again.
{
"error": "No build v7 is kept",
"code": "not_found"
}Packs/api/public/v1/packs
401
unauthorizedThe key is missing, mistyped, revoked or expired.
403
plan_requiredThe account is not on Max.
403
scope_missingThe key has scopes, and packs:read (or webhooks) is not one of them.
404
not_foundNo such pack for this account, or no build with that number is kept. Builds rotate: Max keeps the newest 100.
400
bad_requestA build that is not a number, v5 or latest; more than 500 hashes in one call.
400
bad_urlA webhook address that is not https, or is private.
409
webhook_limitTen webhooks already.
429
rate_limitedOver 300 calls a minute for this key. retryAfter says when.
Resource API
For the zoovdev_sync FiveM resource, on Pro and Max: it turns an image into a 3D prop, priced as the workspace prices one, and deploys it to your linked server. The resource makes the calls for you; scripts on the server call its exports with a key. Base https://zoov.dev/api/v1, the same Authorization header.
Routes
POST /fivem/props/stage-uploadJSON- An upload slot for a PNG or JPG, good for 10 minutes.
POST /fivem/props/from-imageJSON- Starts the prop and sends it to the linked server when it is ready. Answers taskId and status.
Exports
createPropFromImage- Queue, watch and deploy. The default.
queuePropFromImageTask- Queue only.
getPropTaskStatus- pending, ready or failed.
watchPropTask- Watch in the background.
deployPropFromTask- Deploy a finished task.
stopWatchingPropTask- Stop watching.
recoverPropTask- Resume a task after a restart.
Arguments
apiKeystring obrigatório- A zv_ key from /app/api. Any plan.
imagePathstring obrigatório- A local PNG or JPG.
propNamestring obrigatório- Letters, digits and underscores, 64 at most.
optionstable- { scale }, default 1.0, 100 at most.
callbackfunction- (success, result)
Setup
Link the server at /app/api, and start it with +set nodejs_allowFsWrite zoovdev_sync. Without that argument, deploys fail with "Permission denied". "No linked server" means the link command needs running again in the server console.
exports.zoovdev_sync:createPropFromImage(
'zv_your_key',
'images/crate.png',
'my_crate',
{ scale = 1.0 },
function(success, result)
print(success, json.encode(result))
end
)