Skip to content

App Instance API

This section describes the endpoints /appinstances and /control with their associated resources.

GET List all App Instances

Return a list of all app instances in the acount with the specified user credientials.

Requires for authentication a Username and Password.

Method URL Sample URL
GET /appinstances https://app.singular.live/apiv1/appinstances

REQUEST

No query parameters

RESPONSE

STATUS 200 - application/json - Returns an array with full JSON representation of the app instance properties

EXAMPLE

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
[
  {
    "id": 36786,
    "tenant_id": null,
    "account_id": 56,
    "user_id": 2290,
    "is_deleted": 0,
    "fid": "90bf398b-cd61-4fdd-9874-a8097e01fca0",
    "name": "App-for-DevDocs-Graphic SDK",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/36786",
    "thumbnail": "//apptemplates.singular.live/57/109/icon.png",
    "category": null,
    "apptemplate_id": 57,
    "apptemplate_version": 109,
    "created_at": "2018-08-17T12:20:39.000Z",
    "updated_at": "2018-08-17T12:21:41.000Z",
    "deleted_at": null,
    "flowjob_id": null,
    "onair_url": "https://app.singular.live/output/4p8hFLzgnKgMIPXaM2YsNi/Output?aspect=16:9",
    "control_url": "https://app.singular.live/app/36786/control",
    "access_token": null,
    "share_control_url": null,
    "share_api_url": null,
    "outputs": [
      {
        "name": "Output",
        "device_id": null,
        "composition": {
          "id": 85834,
          "name": "Comp-for-DevDocs",
          "thumbnail": "http://images-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/images/c6924113560345e4be15a4472b7c648c~mv2/v1/fit/w_150,h_150/7435edf778b68e42fa3b268e16967292.png#w_490,h_276,mt_image%2Fpng"
        }
      }
    ]
  },
  {
    "id": 36766,
    "tenant_id": null,
    "account_id": 56,
    "user_id": 2290,
    "is_deleted": 0,
    "fid": "65590486-83b8-473a-bab6-ad5e0e22ea86",
    "name": "App-for-DevDocs-REST API",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/36766",
    "thumbnail": "//apptemplates.singular.live/57/109/icon.png",
    "category": null,
    "apptemplate_id": 57,
    "apptemplate_version": 109,
    "created_at": "2018-08-17T10:49:07.000Z",
    "updated_at": "2018-08-17T12:21:30.000Z",
    "deleted_at": null,
    "flowjob_id": null,
    "onair_url": "https://app.singular.live/output/35eUbv7rQO1zHGinkR0OWy/Output?aspect=16:9",
    "control_url": "https://app.singular.live/app/36766/control",
    "access_token": "2gzVUSk2pFmDI7dK53KX5g",
    "outputs": [
      {
        "name": "Output",
        "device_id": null,
        "composition": {
          "id": 85834,
          "name": "Comp-for-DevDocs",
          "thumbnail": "http://images-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/images/c6924113560345e4be15a4472b7c648c~mv2/v1/fit/w_150,h_150/7435edf778b68e42fa3b268e16967292.png#w_490,h_276,mt_image%2Fpng"
        }
      }
    ]
  }
]

STATUS 401 Returned if authorisation failed.

EXAMPLE

1
2
3
4
5
6
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}

GET List Properties of an App Instance

Return the properties of one specific app instance.

Requires for authentication a Username and Password.

Method URL Sample URL
GET /appinstances/{app_instance_id} https://app.singular.live/apiv1/appinstances/36766

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes

RESPONSE

STATUS 200 - application/json - Returns full JSON representation of the app instance properties

EXAMPLE

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "id": 36766,
  "tenant_id": null,
  "account_id": 56,
  "user_id": 2290,
  "is_deleted": 0,
  "fid": "65590486-83b8-473a-bab6-ad5e0e22ea86",
  "name": "App-for-DevDocs-REST API",
  "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/36766",
  "thumbnail": "//apptemplates.singular.live/57/109/icon.png",
  "category": null,
  "apptemplate_id": 57,
  "apptemplate_version": 109,
  "created_at": "2018-08-17T10:49:07.000Z",
  "updated_at": "2018-08-17T12:21:30.000Z",
  "deleted_at": null,
  "dontUpdateTS": true,
  "flowjob_id": null,
  "onair_url": "https://app.singular.live/output/35eUbv7rQO1zHGinkR0OWy/Output?aspect=16:9",
  "control_url": "https://app.singular.live/app/36766/control",
  "access_token": "2gzVUSk2pFmDI7dK53KX5g",
  "outputs": [
    {
      "name": "Output",
      "device_id": null,
      "composition": {
        "id": 85834,
        "name": "Comp-for-DevDocs",
        "thumbnail": "http://images-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/images/c6924113560345e4be15a4472b7c648c~mv2/v1/fit/w_150,h_150/7435edf778b68e42fa3b268e16967292.png#w_490,h_276,mt_image%2Fpng"
      }
    }
  ]
}

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined or not found.

GET List Model of composition in an App Instance

Return the model description of the composition loaded into an app instance.

Requires for authentication a Username and Password.

Method URL Sample URL
GET /appinstances/{app_instance_id}/model https://app.singular.live/apiv1/appinstances/36766/model

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes

RESPONSE

STATUS 200 - application/json - Returns full JSON representation of the app instance properties

EXAMPLE

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
{
  "data": [
    {
      "id": "-LK6VBJKfomRmhME0p4P",
      "name": "default",
      "controlnode": {
        "id": "controlNode",
        "name": "Control Node",
        "thumbnail": "/images/noimage.png"
      },
      "logicLayer": null,
      "subcompositions": [
        {
          "id": "7e07a5d6-b50f-47b2-b036-d39033d109f7",
          "name": "Lower Topic",
          "state": "Out",
          "controlnode": {
            "id": "controlNode",
            "model": {
              "fields": {
                "d8742624-5ea2-01a0-3bb0-a4183215d558": {
                  "defaultValue": "Default Text",
                  "id": "Subtitle",
                  "index": 2,
                  "title": "Subtitle",
                  "type": "text"
                },
                "dd0c303f-777b-a271-4767-ce7698ad3fae": {
                  "defaultValue": "Default Text",
                  "id": "Title",
                  "index": 1,
                  "title": "Title",
                  "type": "text"
                }
              }
            },
            "name": "Control Node",
            "payload": {
              "Subtitle": "Extra Information",
              "Title": "Title or Name"
            },
            "thumbnail": "/images/noimage.png"
          },
          "logicLayer": {
            "name": "Lower",
            "tag": "#B0C8CD"
          },
          "subcompositions": []
        },
        {
          "id": "c053332b-bf54-48f4-ab40-0da1cf980384",
          "name": "Lower Line",
          "state": "Out",
          "controlnode": {
            "id": "controlNode",
            "model": {
              "fields": {
                "d597b7ce-83b0-5250-2a6a-dbcd284c76a6": {
                  "defaultValue": "Title or Name",
                  "id": "Text",
                  "title": "Text",
                  "type": "text"
                }
              }
            },
            "name": "Control Node",
            "payload": {
              "Text": "Title or Name"
            },
            "thumbnail": "/images/noimage.png"
          },
          "logicLayer": {
            "name": "Lower",
            "tag": "#B0C8CD"
          },
          "subcompositions": []
        }
      ]
    }
  ]
}

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined or not found.

GET List Outputs of an App Instance

Return a list of all outputs defined for an app instance.

Requires for authentication a Username and Password.

Method URL Sample URL
GET /appinstances/{app_instance_id}/outputs https://app.singular.live/apiv1/appinstances/36766/outputs

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes

RESPONSE

STATUS 200 - application/json - Returns an array with the JSON representation of the app output properties

EXAMPLE

1
2
3
4
5
6
7
8
9
[
  {
    "id": "-LK3ta2DgVOgFVEum_do",
    "compExtract": "85834-latest-1534502989760",
    "name": "Output",
    "url": "https://app.singular.live/app/36766/outputs/Output/onair",
    "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/36766"
  }
]

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined or not found.

GET List Control Properties of an App Instance

Return a list of all control properties from the composition loaded into an app instance.

Requires for authentication a Username and Password
or an App Access Token.

Method URL Sample URL
GET /appinstances/{app_instance_id}/control https://app.singular.live/apiv1/appinstances/36766/control
or
GET /control/{app_access_token} https://app.singular.live/apiv1/control/2gzVUSk2pFmDI7dK53KX5g

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes
or
{app_access_token} The generated Access Token of the app instance yes

RESPONSE

STATUS 200 - application/json - Returns an array with full JSON representation of all control properties

RESPONSE

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
[
  {
    "compositionId": "-Kn25RyfewL29LigHvV1",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-KnXXbHZpD6sKVP4iHCD",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-Knh0082CSZTy0CXJ_B_",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-KuOABjx4cCp9ue-KCsy",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-KvPqDvHNziVM7E7VTMw",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-L-HXO60B1jvD-PnjTjx",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-L-_ujsVtSHHDfFSiq88",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-L-a1OKA2VYpvNUd-wD7",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "-L1Wr4faRj-m8tMfYi_B",
    "compositionName": null,
    "animation": {
      "state": "Out1"
    }
  },
  {
    "compositionId": "5e7fa753-6160-4b1c-a1bd-0f10e1315609",
    "compositionName": "Baseline Static",
    "animation": {
      "state": "In"
    },
    "controlNode": {
      "payload": {
        "Baseline Text": "Baseline Text"
      }
    }
  },
  {
    "compositionId": "6437a497-27c5-9246-b06d-1ae353844fc2",
    "compositionName": "Background Image",
    "animation": {
      "state": "In"
    },
    "controlNode": {
      "payload": {
        "Background Image": "//static-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/static/03ee4b23f5a748f2a4d04b0b3ad4a391/file.svg"
      }
    }
  },
  {
    "compositionId": "68c3003e-e569-5caf-cb41-201d53ecf634",
    "compositionName": "Panel Left Image + Text",
    "animation": {
      "state": "In"
    },
    "controlNode": {
      "payload": {
        "Image": "//static-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/static/25c72aa01a014393b87fd8e77e06db8e/file.svg",
        "Image Position X": "-37",
        "Image Position Y": "-29",
        "Image Size": "24",
        "Text": "Up to 5 lines of text with\ncarriage returns can go here.\nLine 3\nLine 4\nLine 5",
        "Title": "TITLE"
      }
    }
  },
  {
    "compositionId": "7e07a5d6-b50f-47b2-b036-d39033d109f7",
    "compositionName": "Lower Topic 2 Line",
    "animation": {
      "state": "In"
    },
    "controlNode": {
      "payload": {
        "Subtitle": "Extra Information",
        "Title": "Title or Name"
      }
    }
  },
  {
    "compositionId": "ba8b75bc-e122-973f-04a7-8ff799ae41aa",
    "compositionName": "Fullscreen Title",
    "animation": {
      "state": "Out2"
    },
    "controlNode": {
      "payload": {
        "Subtitle": "Extra Text - 1 to 5 lines",
        "Title": "TITLE - 1 to 3 lines"
      }
    }
  },
  {
    "compositionId": "c053332b-bf54-48f4-ab40-0da1cf980384",
    "compositionName": "Lower 1 Line - Large",
    "animation": {
      "state": "Out2"
    },
    "controlNode": {
      "payload": {
        "Text": "Title or Name"
      }
    }
  }
]

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined or not found.

GET List Subcompositions of an App Instance

Return a list of all subcompositions of the composition loaded into an app instance.

Requires for authentication a Username and Password
or an App Access Token.

Method URL Sample URL
GET /appinstances/{app_instance_id}/subcompositions https://app.singular.live/apiv1/appinstances/36766/subcompositions
or
GET /control/{app_access_token}/subcompositions https://app.singular.live/apiv1/control/2gzVUSk2pFmDI7dK53KX5g/subcompositions

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes
or
{app_access_token} The generated Access Token of the app instance yes

RESPONSE

STATUS 200 - application/json - Returns an array with full JSON representation of all subcompositions

EXAMPLE

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "data": [
    {
      "id": "7e07a5d6-b50f-47b2-b036-d39033d109f7",
      "name": "Lower Topic",
      "state": "Out",
      "logicLayer": {
        "name": "Lower",
        "tag": "#B0C8CD"
      }
    },
    {
      "id": "ba8b75bc-e122-973f-04a7-8ff799ae41aa",
      "name": "Fullscreen Title",
      "state": "Out",
      "logicLayer": {
        "name": "Fullscreen",
        "tag": "#CEAEC8"
      }
    },
    {
      "id": "c053332b-bf54-48f4-ab40-0da1cf980384",
      "name": "Lower Line",
      "state": "Out",
      "logicLayer": {
        "name": "Lower",
        "tag": "#B0C8CD"
      }
    }
  ]
}

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined or not found.

PUT Load Composition into an App Instance

Load a composition specified by the composition Id into an app instance.

Requires for authentication a Username and Password

Method URL Sample URL
PUT /appinstances/{app_instance_id}/composition https://app.singular.live/apiv1/appinstances/36766/composition

REQUEST

PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes

REQUEST BODY

1
2
3
{
  "refId": "85836"
}

RESPONSE

STATUS 200 - application/json - Returns Ok

STATUS 400 Bad Request: Returned if the body JSON is wrong, the composition with the refId does not exist or you don't have permission to access it.

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined, not found or composition id there is no outputs in the instance.

DELETE Remove Composition from an App Instance

Remove a composition from the specified app instance

Requires for authentication a Username and Password

Method URL Sample URL
DELETE /appinstances/{app_instance_id}/composition https://app.singular.live/apiv1/appinstances/36766/composition

REQUEST

PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes

RESPONSE

STATUS 200 - application/json - Returns Ok

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined, not found or composition id there is no outputs in the instance.

PUT Update Show Data in an App Instance

Update the show data of a composition loaded into an app instance.

Requires for authentication a Username and Password
or an App Access Token.

Method URL Sample URL
PUT /appinstances/{app_instance_id}/control https://app.singular.live/apiv1/appinstances/36766/control
or
PUT /control/{app_access_token} https://app.singular.live/apiv1/control/2gzVUSk2pFmDI7dK53KX5g

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes
or
{app_access_token} The generated Access Token of the app instance yes

REQUEST BODY

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
[
  {
    "compositionName": "Lower Topic 2 Line",
    "controlNode": {
      "payload": {
        "Title": "Title or Name...",
        "Subtitle": "Extra Information..."
      }
    }
  }
]

RESPONSE

STATUS 200 - application/json - Returns Ok

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined not found or there is no outputs in the instance.

PUT Control Animations of an App Instance

Control and trigger a specific animation between defined ainimation states.

Animation Styles

Action Description
play Play animation between two animation states
jump Jump from one animation state to another

Animation States

State Description
In In State
Out Default Out State
Out1 First Out state (if composition has two timelines)
Out2 Second Out state (if composition has two timelines)

Play the animation of a subcomposition loaded into an app instance.

Requires for authentication a Username and Password
or an App Access Token.

Method URL Sample URL
PUT /appinstances/{app_instance_id}/control https://app.singular.live/apiv1/appinstances/36766/control
or
PUT /control/{app_access_token} https://app.singular.live/apiv1/control/2gzVUSk2pFmDI7dK53KX5g

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of the app instance yes
or
{app_access_token} The generated Access Token of the app instance yes

REQUEST BODY

EXAMPLE: Play animation from the current state to state In.

1
2
3
4
5
6
7
8
9
[
  {
    "compositionName": "Panel Left Image + Text",
    "animation": {
      "action": "play",
      "to": "In"
    }
  }
]

EXAMPLE: Jump to the state Out2.

1
2
3
4
5
6
7
8
9
[
  {
    "compositionName": "Panel Left Image + Text",
    "animation": {
      "action": "jump",
      "to": "Out2"
    }
  }
]

RESPONSE

STATUS 200 - application/json - Returns Ok

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if app instance id undefined or not found.

POST Create an App Instance

Create a new app instance from an existing app template.

Requires for authentication a Username and Password

Method URL Sample URL
POST /appinstances https://app.singular.live/apiv1/appinstances

REQUEST

NO PARAMETERS

REQUEST BODY

The request body are key/value pairs of properties of the app instance to create.

Parameter Description Required
folder id of the destination folder for created app instance yes
name name for the new app instance yes
apptemplate_id id of the app template.
"apptemplate_id": "57": Singular Studio
"apptemplate_id": "85": Singular Spark
yes
apptemplate_version_status status of the app template version
published: latest published version
delevopment: development version
yes
apptemplate_version_id specifiy the version id of an app template. this parameter replaces the apptemplate_version_status
95: version 95 of app template
optional
outputList key/value pairs of output names and defaultCompositions not required for Studio and Spark optional
compositionList key/value pairs of Name and refId of compositions not required for Studio and Spark optional
account_id optional: id of the account, the app instance is created for. optional
user_id optional: id of the user, the app instance is created for optional
shareurl optional: "shareurl": "0": don't create share URL optional
optional: "shareurl": "1": create share URL optional

The request body for outputList specification:

Key Description
Name Specify a Name for the Output
defaultComposition Index of composition from the compositionList

The request body for compositionList specification:

Key Description
Name Specify a Name for the compositionList
refId composition id of the composition

Example: Request body with minimal specification

1
2
3
4
5
6
{
  "folder": "4e867728-b556-4d10-8761-afecf431614b",
  "apptemplate_id": "57",
  "apptemplate_version_status": "published",
  "name": "New Studio Control (no composition specified)"
}

Example: Request body with full specification

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "folder": "4e867728-b556-4d10-8761-afecf431614b",
  "apptemplate_id": "57",
  "apptemplate_version_status": "published",
  "name": "New Studio Control (composition specified)",
  "compositionList": [
    {
      "name": "Comp-for-DevDocs",
      "composition": {
        "refId": "85834"
      }
    }
  ],
  "account_id": "56",
  "user_id": "2290",
  "shareurl": "0"
}

RESPONSE

STATUS 200 - application/json - Returns full JSON representation of the created app instance

Example: Response for request body using minimal specification

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "user_id": 2290,
  "account_id": 56,
  "tenant_id": null,
  "name": "New Studio Control (no composition specified)",
  "fid": "bd229918-9b6d-4800-9a8a-4171ef7a508d",
  "apptemplate_id": "57",
  "apptemplate_version": 109,
  "thumbnail": "//apptemplates.singular.live/57/109/icon.png",
  "updated_at": "2018-08-17T17:01:46.762Z",
  "created_at": "2018-08-17T17:01:46.755Z",
  "id": 36910,
  "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/36910",
  "refId": 36910,
  "type": "appinstance",
  "flowjob_id": null,
  "onair_url": "https://app.singular.live/output/5KTmof0o7n83LBu6c5yqAJ/Output?aspect=16:9",
  "control_url": "https://app.singular.live/app/36910/control",
  "outputs": [
    {
      "name": "Output",
      "device_id": null
    }
  ],
  "access_token": null,
  "share_control_url": null,
  "share_api_url": null
}

Example: Response for request body using full specification

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "user_id": 2290,
  "account_id": 56,
  "tenant_id": null,
  "name": "New Studio Control (composition specified)",
  "fid": "9ee77a28-5411-45ce-b324-5700f084acba",
  "apptemplate_id": "57",
  "apptemplate_version": 109,
  "thumbnail": "//apptemplates.singular.live/57/109/icon.png",
  "updated_at": "2018-08-17T17:05:31.038Z",
  "created_at": "2018-08-17T17:05:31.032Z",
  "id": 36911,
  "firebaseUrl": "https://fiery-torch-2122.firebaseio.com/accounts/56/appinstances/36911",
  "refId": 36911,
  "type": "appinstance",
  "access_token": "2jLNN9vSAT2JairqrCsvOO",
  "flowjob_id": null,
  "onair_url": "https://app.singular.live/output/4PQzwJ3sWRKeXAxJBEriMa/Output?aspect=16:9",
  "control_url": "https://app.singular.live/app/36911/control",
  "outputs": [
    {
      "name": "Output",
      "device_id": null,
      "composition": {
        "id": 85834,
        "name": "Comp-for-DevDocs",
        "thumbnail": "http://images-singularlive.wixmp.com/356a192b7913b04c54574d18c28d46e6395428ab/images/c6924113560345e4be15a4472b7c648c~mv2/v1/fit/w_150,h_150/7435edf778b68e42fa3b268e16967292.png#w_490,h_276,mt_image%2Fpng"
      }
    }
  ]
}

STATUS 400 Bad Request: Returned if the body JSON is wrong and any of the specified Ids does not exist.

STATUS 401 Returned if authorisation failed.

DELETE Delete App Instance

Delete an App Instance in your account.

Requires for authentication a Username and Password

Method URL Sample URL
DELETE /appinstances/{app_instance_id} https://app.singular.live/apiv1/appinstances/12345

REQUEST

QUERY PARAMETERS

Parameter Description Required
{app_instance_id} The Id of an app instance yes

RESPONSE

STATUS 200 - application/json - Returns Ok

STATUS 401 Returned if authorisation failed.

STATUS 404 Returned if the app instance id undefined or not found.