Search

Definition

GET https://clara.io/api/users/[username]/scenes?{type=gallery}&{query=[query]}&{page=[page number]}&{perPage==[number per page]}

GET https://clara.io/api/scenes?type=library&{query=[query]}&{public=true}&{page=[page number]}&{perPage==[number per page]}

Example Request

Request all specific user’s scenes if you are that user:

curl "https://clara.io/api/users/username/scenes" \
    -u username:c3be3060-fe81-467b-aa62-0ee42eea9c8b

Search within a specific user’s scenes if you are that user:

curl "https://clara.io/api/users/username/scenes?query=car" \
    -u username:c3be3060-fe81-467b-aa62-0ee42eea9c8b

Request a user’s public and gallery scenes without being logged in:

curl "https://clara.io/api/users/jasonshoumar/scenes?type=gallery"

Search a user’s public and gallery scenes without being logged in:

curl "https://clara.io/api/users/jasonshoumar/scenes?type=gallery&query=car"

List the first 100 scenes in the public library (includes both public and gallery only):

curl "https://clara.io/api/scenes?page=1&perPage=100&type=library"

Search the first 100 the public library that match the query ‘car’ (includes both public and gallery only):

curl "https://clara.io/api/scenes?page=1&perPage=100&type=library&query=car"

Limit the search in the public library for only those scenes that are downloadable (public):

curl "https://clara.io/api/scenes?page=1&perPage=100&type=library&query=car&public=true"

Example Response

{
    "models": [
        {
            "__v": 0,
            "_id": "59f6f456-cdb4-4c77-a578-4de894bc53c5",
            "access": [],
            "allowPublicClone": true,
            "createdAt": "2013-10-07T16:39:26.008Z",
            "description": "REST API description set.",
            "id": "59f6f456-cdb4-4c77-a578-4de894bc53c5",
            "license": "custom",
            "modifiedAt": "2013-10-08T17:42:50.656Z",
            "name": "DemoScene",
            "owner": "user",
            "pluginAccess": [],
            "public": true,
            "version": 10
        },
        {
            "__v": 0,
            "_id": "bf37126d-cb2b-41dd-bfde-09705da00e5b",
            "access": [],
            "allowPublicClone": false,
            "createdAt": "2013-10-07T16:46:57.742Z",
            "id": "bf37126d-cb2b-41dd-bfde-09705da00e5b",
            "modifiedAt": "2013-10-07T16:47:07.457Z",
            "name": "Untitled Scene",
            "owner": "user",
            "pluginAccess": [],
            "public": false,
            "version": 37
        },
        {
            "__v": 0,
            "_id": "316d5cca-8134-4dc5-865b-fc2ac9b1df39",
            "access": [],
            "allowPublicClone": false,
            "createdAt": "2013-10-07T16:46:07.466Z",
            "id": "316d5cca-8134-4dc5-865b-fc2ac9b1df39",
            "modifiedAt": "2013-10-07T16:46:51.493Z",
            "name": "Untitled Scene",
            "owner": "user",
            "pluginAccess": [],
            "public": false,
            "version": 36
        }
    ],
    "page": 1,
    "perPage": 100,
    "total": 3
}

Clara Node SDK

When using the Clara Node SDK:

$ clara scenes:library [options]

Next (New Scene) Previous (Thumbnails)