NEOLearn

ContentService

Uploading content: upload sessions straight to storage, validation, the upload quota and cook status.

Updated October 21, 2026

On this page

Content uploads, validation and cooking. Uploading a file: 1. CreateUploadSession with the file's SHA-256, size, content type and name. If the platform already has those bytes, the session comes back complete with their URL and nothing is uploaded (a republish uploads only what changed). 2. Otherwise send the bytes the way the session says (method): put one HTTP PUT of the whole file to put_url (presigned, straight to the object store: the bytes never pass through the API) multipart part_count PUTs of part_size bytes (the last one shorter) to the URLs GetUploadPartUrls hands out; resumable: GetUploadSession lists the parts already received proxy one PUT of the whole file to put_url on the API itself, with the same bearer token (deployments without a public object store endpoint; development) 3. CompleteUpload: the platform checks the received bytes against the declared hash and size, validates them (file type by content, limits per asset, no external references) and stores them under their hash. A file that fails comes back rejected with problems saying what is wrong, measured against which limit. Sessions belong to the account that made them and expire (expires_at); every id is public. Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.

Summary#

MethodAuthDescription
CreateUploadSessionAccount
GetUploadSessionAccount
GetUploadPartUrlsAccountPresigned URLs for some parts of a multipart session (at most 100 per call).
CompleteUploadAccount
AbortUploadAccount
GetUploadQuotaAccountThe caller's upload quota and what is used of it.
GetVersionCooksunknownWhere cooking a version's content stands, per cook target (the version's creator).

Methods#

CreateUploadSession#

HTTP
POST /neo.platform.v1.ContentService/CreateUploadSession
Content-Type: application/json

Auth: A signed-in account. Guests are refused. Also callable with a scoped token: studio.

Request: CreateUploadSessionRequest. Response: UploadSession.

GetUploadSession#

HTTP
POST /neo.platform.v1.ContentService/GetUploadSession
Content-Type: application/json

Auth: A signed-in account. Guests are refused. Also callable with a scoped token: studio.

Request: UploadSessionRef. Response: UploadSession.

GetUploadPartUrls#

Presigned URLs for some parts of a multipart session (at most 100 per call).

HTTP
POST /neo.platform.v1.ContentService/GetUploadPartUrls
Content-Type: application/json

Auth: A signed-in account. Guests are refused. Also callable with a scoped token: studio.

Request: GetUploadPartUrlsRequest. Response: GetUploadPartUrlsResponse.

CompleteUpload#

HTTP
POST /neo.platform.v1.ContentService/CompleteUpload
Content-Type: application/json

Auth: A signed-in account. Guests are refused. Also callable with a scoped token: studio.

Request: UploadSessionRef. Response: UploadSession.

AbortUpload#

HTTP
POST /neo.platform.v1.ContentService/AbortUpload
Content-Type: application/json

Auth: A signed-in account. Guests are refused. Also callable with a scoped token: studio.

Request: UploadSessionRef. Response: UploadSession.

GetUploadQuota#

The caller's upload quota and what is used of it.

HTTP
POST /neo.platform.v1.ContentService/GetUploadQuota
Content-Type: application/json

Auth: A signed-in account. Guests are refused. Also callable with a scoped token: studio.

Request: GetUploadQuotaRequest. Response: UploadQuota.

GetVersionCooks#

Where cooking a version's content stands, per cook target (the version's creator).

HTTP
POST /neo.platform.v1.ContentService/GetVersionCooks
Content-Type: application/json

Auth: unknown Also callable with a scoped token: studio.

Request: GetVersionCooksRequest. Response: VersionCooks.

Types#

ContentInfo#

What validation learned about a file.

FieldTypeDescription
kindstringmodel, image, audio, json, text, data
formatstringglb, gltf, png, jpeg, webp, ktx2, exr, wav, ogg, flac, json, text, data
trianglesstring (int64)
bonesnumber
widthnumberAn image's size; for a model, its largest texture.
heightnumber
durationMsstring (int64)
texturesnumber

CreateUploadSessionRequest#

FieldTypeDescription
sha256stringLower-case hex SHA-256 of the whole file.
sizestring (int64)
contentTypestringe.g. model/gltf-binary, image/png, audio/ogg, application/json, text/plain, application/octet-stream (the platform checks it against what the bytes are).
namestringThe file's name or project path (models/tree.glb): its extension must fit its content, and validation messages name it.

GetUploadPartUrlsRequest#

FieldTypeDescription
sessionIdstring
partNumbersarray of number1-based part numbers; empty: every part not received yet (up to 100).

GetUploadPartUrlsResponse#

FieldTypeDescription
partsarray of UploadPartUrl
expiresAtstring

GetUploadQuotaRequest#

No fields: send {}.

GetVersionCooksRequest#

FieldTypeDescription
experienceIdstring
versionIdstringver_...; empty: the live version.

TargetCook#

FieldTypeDescription
targetstringdesktop, web
statusstringwaiting (nothing cooked yet), cooking, done, failed, none (the version has no cookable files)
totalnumber
donenumber
failednumber
manifestUrlstringdone: the version's cooked manifest for this target (path -> cooked content URL).
cookerstringThe cooker that made it (platform-passthrough-1, or the engine's neo-cook-x.y.z).
errorsarray of stringfailed: the first few failures (models/tree.glb:...).

UploadPartUrl#

FieldTypeDescription
partNumbernumber
urlstring
sizestring (int64)

UploadQuota#

FieldTypeDescription
usedTodaystring (int64)Bytes uploaded in the last 24 hours (open sessions count: their bytes are reserved).
dailyLimitstring (int64)
storageUsedstring (int64)Bytes of stored content this account uploaded first (content shared with others counts once, for whoever uploaded it first).
storageLimitstring (int64)
maxFileSizestring (int64)The largest single file.
openSessionsnumber
openSessionsLimitnumber

UploadSession#

FieldTypeDescription
idstringupl_...
statusstringopen (waiting for the bytes), complete, rejected (see problems), expired, aborted
sha256string
sizestring (int64)
contentTypestring
namestring
methodstringnone (complete already: the platform had the bytes), put, multipart, proxy
putUrlstringput and proxy: where to PUT the file.
putHeadersobject (map of string to string)Headers to send with every PUT (besides the bearer token for proxy).
partSizestring (int64)multipart: every part is part_size bytes but the last.
partCountnumber
partsReceivedarray of numbermultipart: the part numbers already received (to resume).
expiresAtstring
urlstringcomplete: the content's URL (content-addressed, immutable).
problemsarray of ValidationProblemrejected: why.
infoContentInfo
createdAtstring

UploadSessionRef#

FieldTypeDescription
sessionIdstring

ValidationProblem#

One thing wrong with an uploaded file.

FieldTypeDescription
rulestringA stable rule id: glb.truncated, glb.external_uri, glb.triangles, image.too_large, type.mismatch, hash.mismatch, size.mismatch,...
messagestringA sentence for people: what is wrong and how to fix it.
atstringWhere in the file (images[2], meshes[0].primitives[1]), when it applies.
measuredstringWhat was measured and the limit it broke, when the rule is a limit.
limitstring

VersionCooks#

FieldTypeDescription
versionIdstring
targetsarray of TargetCook

See also#