User Manual

Apps - Download app

Route URL

POST https://playcanvas.com/api/apps/download

Description

This will allow you to download an app which you can self host on your own server. The request will start an export job and the job details will be returned in the response. You can poll the job by id until its status is either 'complete' or 'error'. When the job is done, it's data will contain a URL to download the exported app.

Example

curl -H "Authorization: Bearer fdslkjlk32j2l3kj2lkj2lkj323rr" -H "Content-Type: application/json" -X POST -d '{"project_id": 9999999, "name": "My App"}' https://playcanvas.com/api/apps/download

Parameters

project_id

The id of the project.

name

The name of the app. Must be less than 1000 characters

scenes [optional]

A list of scene ids to be included in the app. If no scenes are specified then the primary scene of the project is used. When you specify scenes then the first scene in the list will be used as the initial scene of the application.

target [optional]

Can be either 'web' or 'ios'. Use 'web' to download a normal app or use 'ios' to download an XCode project. If no target is specified it defaults to 'web'.

description [optional]

The description of the app. Must be less than 10,000 characters.

version [optional]

The version of the app. Can be a string up to 20 characters.

release_notes [optional]

Release notes for the app. Can be a string up to 10,000 characters.

scripts_concatenate [optional]

Boolean. Set it to true if you want scripts to be concatenated.

Response Schema

Status: 201 Created
{
    "id": int,
    "created_at": date,
    "modified_at": date,
    "status": "running" or "complete" or "error",
    "messages": list of strings,
    "data": {
      'owner_id': int,
      'project_id': int,
      'scenes': list of int scene ids,
      'name': string,
      'target': string,
      'concatenate': boolean,
      "download_url": string
    }
}

Errors

401

Unauthorized

403

Forbidden

404

Project not found

404

Owner not found

404

Scene not found

429

Too many requests

Rate Limiting

This route uses a strict rate limit.