Uploading templates

A template arrives through the API as the package the Nubu Builder exports: one .zip. Nubu reads it after the upload and checks it exactly as the upload drawer in the app would.

What the package must contain#

• the .nubu.json schema and the After Effects .aep project the Builder exported;
• a thumbnail.jpg or thumbnail.png at the top level;
• an examples folder with one rendered example per comp, each named after its comp (for example REEL_10S_1080x1920.mp4 or REEL_10S_1080x1920_EXAMPLE.mp4);
• an After Effects version Nubu supports.

The Builder's export has all of this. A package that does not is refused with every problem named, and nothing half-finished enters the gallery.

Uploading#

The flow is the asset upload's: begin, PUT the zip, complete. A package that would not fit the organisation's remaining storage is refused at the begin, and at a replacement, with 409 conflict and details.reason storage_full; deleting templates frees the space at once.

curl -X POST https://app.nubu.app/api/v1/templates/uploads \
  -H "Authorization: Bearer nubu_api_..." \
  -H "Content-Type: application/json" \
  -d '{ "filename": "summer-sale.zip", "size_bytes": 83211042, "name": "Summer sale" }'

The answer (201) carries the template_id and an upload plan (a single PUT at or under 100 MiB, else multipart parts; see Uploading assets for the part mechanics, with POST /templates/uploads/<template_id>/parts for fresh part URLs). PUT the zip with Content-Type: application/zip, then complete:

curl -X POST https://app.nubu.app/api/v1/templates/uploads/<template_id>/complete \
  -H "Authorization: Bearer nubu_api_..." \
  -H "Content-Type: application/json" \
  -d '{}'

(Send { "upload_id": "..." } for a multipart upload.) Nubu reads the package, and the answer carries the ready template: its comps, the examples with the comp each one belongs to, and a download_url for the package.

A refused package answers 422 validation_failed; details lists one entry per problem, each with a code:

Fix the package and upload it again. POST /templates/uploads/<template_id>/abort abandons an upload before it is completed.

Reading, editing, replacing and deleting#

• GET /templates lists templates (filters: folder_id, status, q, tag); GET /templates/<id> adds the comps, the examples and a 15-minute download_url for the package.
• PATCH /templates/<id> with any of name, tags and folder_id.
• Replacing a package keeps the template id and every flow that uses it. POST /templates/<id>/replace with size_bytes answers an upload plan and a version; PUT the new zip, then POST /templates/<id>/replace/complete with that version (and the upload_id for a multipart one). The new package is checked like a fresh upload; until it passes, the current package stays live. POST /templates/<id>/replace/parts re-mints part URLs and POST /templates/<id>/replace/abort discards the attempt.
• DELETE /templates/<id> removes the template and its files. A template used by a creative that is queued or rendering answers 409 conflict until that render finishes.