0xDocs 0x.limo

Docs / REST API

User-generated content

Generated reference for the 11 /v1/ugc operations of the 0x REST API.

Generated from steamworks sg-backend/openapi.yaml at build 3a4a58e45c+dirty. Do not edit by hand.

Errors are {"error": "..."} with the status (errors); limits are in rate limits.

MethodPathAuthSummary
GET/v1/ugc/{id}Bearer tokenItem
PUT/v1/ugc/{id}Bearer tokenOwner commits an update
DELETE/v1/ugc/{id}Bearer tokenOwner deletes
POST/v1/ugc/{id}/content_urlsBearer token{method:
GET/v1/ugc/{id}/contentBearer tokenFile list [{name, size, sha256}]
GET/v1/ugc/{id}/content/{path}Bearer tokenDownload a file
PUT/v1/ugc/{id}/content/{path}Bearer tokenOwner uploads a file
GET/v1/ugc/{id}/previewBearer tokenPreview image
PUT/v1/ugc/{id}/previewBearer tokenOwner sets the preview
POST/v1/ugc/{id}/{action}Bearer tokenSubscribe, unsubscribe, vote {up}, favorite {add}
GET/v1/ugc/{id}/voteBearer token{voted_up, voted_down, skipped}

#GET /v1/ugc/{id}

Item (with vote and subscription counts)

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200OK
404Not visible
bash
curl -s "https://api.0x.limo/v1/ugc/$ID" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#PUT /v1/ugc/{id}

Owner commits an update (metadata, tags, kv, visibility, change note, file list); finalising a file list runs the upload scanner over each file and records its sha256 plus the item's content_sha256, and an optional {signature: {key, sig}} over the item id and that hash is verified and relayed

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200OK
400Bad or non-matching signature
403Not the owner
451The scanner refused a file
bash
curl -s -X PUT "https://api.0x.limo/v1/ugc/$ID" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#DELETE /v1/ugc/{id}

Owner deletes

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200OK Ok
bash
curl -s -X DELETE "https://api.0x.limo/v1/ugc/$ID" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/ugc/{id}/content_urls

{method: PUT|GET, names} → {urls} (pre-signed); GET urls are issued only for files on the item's list

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200OK
404That name is not part of this item's content
bash
curl -s -X POST "https://api.0x.limo/v1/ugc/$ID/content_urls" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/ugc/{id}/content

File list [{name, size, sha256}]

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/ugc/$ID/content" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/ugc/{id}/content/{path}

Download a file

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
pathpathstringyesrelative path, / separated; no . or .. parts
StatusResponse
200File contents (application/octet-stream)
bash
curl -s "https://api.0x.limo/v1/ugc/$ID/content/$PATH" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#PUT /v1/ugc/{id}/content/{path}

Owner uploads a file

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
pathpathstringyesrelative path, / separated; no . or .. parts
StatusResponse
200OK
bash
curl -s -X PUT "https://api.0x.limo/v1/ugc/$ID/content/$PATH" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/ugc/{id}/preview

Preview image

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200File contents (application/octet-stream)
bash
curl -s "https://api.0x.limo/v1/ugc/$ID/preview" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#PUT /v1/ugc/{id}/preview

Owner sets the preview

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200OK Ok
bash
curl -s -X PUT "https://api.0x.limo/v1/ugc/$ID/preview" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#POST /v1/ugc/{id}/{action}

Subscribe, unsubscribe, vote {up}, favorite {add}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
actionpath"subscribe" | "unsubscribe" | "vote" | "favorite"yes
StatusResponse
200OK Ok
bash
curl -s -X POST "https://api.0x.limo/v1/ugc/$ID/$ACTION" \
  -H "Authorization: Bearer $ZEROX_TOKEN"

#GET /v1/ugc/{id}/vote

{voted_up, voted_down, skipped}

Auth: Bearer token: Authorization: Bearer <access token> (authentication).

ParameterInTypeRequiredDescription
idpathstringyes
StatusResponse
200OK
bash
curl -s "https://api.0x.limo/v1/ugc/$ID/vote" \
  -H "Authorization: Bearer $ZEROX_TOKEN"