Skip to main content
API docs by Redocly

Smriti API (24.06.15)

Download OpenAPI specification:Download

Smarter Home for all your Photos and Videos

MediaItems

Everything related to your Photos & Videos

Get all existing mediaItems

Get all existing mediaItems

Authorizations:
bearerAuth
query Parameters
page
number
Default: 1

Pagination page

limit
number
Default: 15

Pagination limit

type
string
Example: type=video

MediaItem Type

category
string
Example: category=live

MediaItem Category

status
string
Example: status=FAILED

MediaItem Status

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upload a new mediaItem

Upload a new mediaItem

Authorizations:
bearerAuth

Responses

Get an existing mediaItem

Get an existing mediaItem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of mediaItem

Responses

Response samples

Content type
application/json
{
  • "id": "102dc522de-1669-48a4-8270-4950a0237599",
  • "userId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "filename": "IMG_4942.jpg",
  • "description": "Picture of a pizza from New York",
  • "mimeType": "image/jpeg",
  • "placeholder": "base-64-placeholder-image",
  • "sourceUrl": "https://cdn.smriti/source",
  • "previewUrl": "https://cdn.smriti/preview",
  • "thumbnailUrl": "https://cdn.smriti/thumbnail",
  • "favourite": false,
  • "shared": true,
  • "hidden": false,
  • "deleted": false,
  • "status": "UNSPECIFIED",
  • "mediaItemType": "photo",
  • "mediaItemCategory": "default",
  • "width": 1080,
  • "height": 720,
  • "creationTime": "2022-09-14T16:58:28Z",
  • "latitude": 19.384982,
  • "longitude": -70.638324,
  • "cameraMake": "Apple",
  • "cameraModel": "iPhone 12",
  • "focalLength": "5.49 mm",
  • "apertureFNumber": "f/1.8",
  • "isoEquivalent": "ISO758",
  • "exposureTime": "1/20",
  • "fps": 60,
  • "createdAt": "2022-09-14T16:58:28Z",
  • "updatedAt": "2022-09-14T16:58:28Z"
}

Update an existing mediaItem

Update an existing mediaItem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of mediaItem

Request Body schema: application/json
required

MediaItem request body

description
string
favourite
boolean
hidden
boolean

Responses

Request samples

Content type
application/json
{
  • "description": "Pictures from Wedding of Jane and Doe",
  • "favourite": true,
  • "hidden": false
}

Delete an existing mediaItem

Delete an existing mediaItem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of mediaItem

Responses

Get places from an existing mediaItem

Get places from an existing mediaItem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of mediaItem

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get things from an existing mediaItem

Get things from an existing mediaItem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of mediaItem

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get people from an existing mediaItem

Get people from an existing mediaItem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of mediaItem

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get albums from an existing mediaItem

Get albums from an existing mediaItem

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of mediaItem

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Library

Manage your collections of Photos & Videos

Get all favourite mediaItems

Get all favourite mediaItems

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add favourite mediaItems

Add favourite mediaItems

Authorizations:
bearerAuth
Request Body schema: application/json
required

List of mediaitems request

mediaItems
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "mediaItems": [
    ]
}

Remove favourite mediaItems

Remove favourite mediaItems

Authorizations:
bearerAuth

Responses

Get all hidden mediaItems

Get all hidden mediaItems

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add hidden mediaItems

Add hidden mediaItems

Authorizations:
bearerAuth
Request Body schema: application/json
required

List of mediaitems request

mediaItems
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "mediaItems": [
    ]
}

Remove hidden mediaItems

Remove hidden mediaItems

Authorizations:
bearerAuth

Responses

Get all deleted mediaItems

Get all deleted mediaItems

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add deleted mediaItems

Add deleted mediaItems

Authorizations:
bearerAuth
Request Body schema: application/json
required

List of mediaitems request

mediaItems
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "mediaItems": [
    ]
}

Remove deleted mediaItems

Remove deleted mediaItems

Authorizations:
bearerAuth

Responses

Explore

Features on top of your MediaItems & Albums

Get all mediaItems which are N years ago from given month & date

Get all mediaItems which are N years ago from given month & date

Authorizations:
bearerAuth
path Parameters
monthDate
required
string

Month and Date in MMDD format

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all place entities

Get all place entities

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get mediaItems of a place entity

Get mediaItems of a place entity

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of place

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all thing entities

Get all thing entities

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get mediaItems of a thing entity

Get mediaItems of a thing entity

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of thing

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all people entities

Get all people entities

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a people entity

Update a people entity

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of people

Request Body schema: application/json
required

People request body

name
string
hidden
boolean
coverMediaItemId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "hidden": false,
  • "coverMediaItemId": "102dc522de-1669-48a4-8270-4950a0237599"
}

Get mediaItems of a people entity

Get mediaItems of a people entity

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of people

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Albums

Collection of your Photos & Videos

Get all existing albums

Get all existing albums

Authorizations:
bearerAuth
query Parameters
sort
string
Default: "name"
Example: sort=updatedAt

Sort order

page
number
Default: 1

Pagination page

limit
number
Default: 15

Pagination limit

shared
boolean
Example: shared=false

Shared

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new album

Create a new album

Authorizations:
bearerAuth
Request Body schema: application/json
required

Album request body

name
string
description
string
coverMediaItemId
string <uuid>
shared
boolean
hidden
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Jane's Wedding",
  • "description": "Pictures from Wedding of Jane and Doe",
  • "coverMediaItemId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "shared": true,
  • "hidden": false
}

Get an existing album

Get an existing album

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of album

Responses

Response samples

Content type
application/json
{
  • "id": "102dc522de-1669-48a4-8270-4950a0237599",
  • "userId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "name": "Jane's Wedding",
  • "description": "Pictures from Wedding of Jane and Doe",
  • "coverMediaItemId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "shared": true,
  • "hidden": false,
  • "mediaItemsCount": 42,
  • "createdAt": "2022-09-14T16:58:28Z",
  • "updatedAt": "2022-09-14T16:58:28Z",
  • "coverMediaItem": {
    }
}

Update an existing album

Update an existing album

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of album

Request Body schema: application/json
required

Album request body

name
string
description
string
coverMediaItemId
string <uuid>
shared
boolean
hidden
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Jane's Wedding",
  • "description": "Pictures from Wedding of Jane and Doe",
  • "coverMediaItemId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "shared": true,
  • "hidden": false
}

Delete an existing album

Delete an existing album

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of album

Responses

Get mediaItems of an existing album

Get mediaItems of an existing album

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of album

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add mediaItems to an existing album

Add mediaItems to an existing album

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of album

Request Body schema: application/json
required

List of mediaitems request

mediaItems
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "mediaItems": [
    ]
}

Remove mediaItems from an existing album

Remove mediaItems from an existing album

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of album

Responses

Authentication

Authentication for your application

User Login

User Login

Request Body schema: application/json
required

Login request body

username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "prabhuomkar",
  • "password": "Pwd1234!"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string"
}

User Refresh Token

User Refresh Token

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "refreshToken": "string"
}

User Logout

User Logout

Responses

User Management

User Management for your application

Get all existing users

Get all existing users

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new user

Create a new user

Authorizations:
basicAuth
Request Body schema: application/json
required

User request body

name
string
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "username": "johndoe",
  • "password": "somesecrethash"
}

Get an existing user

Get an existing user

Authorizations:
basicAuth
path Parameters
id
required
string <uuid>

ID of user

Responses

Response samples

Content type
application/json
{
  • "id": "102dc522de-1669-48a4-8270-4950a0237599",
  • "name": "John Doe",
  • "username": "johndoe",
  • "password": "somesecrethash",
  • "createdAt": "2022-09-14T16:58:28Z",
  • "updatedAt": "2022-09-14T16:58:28Z"
}

Update an existing user

Update an existing user

Authorizations:
basicAuth
path Parameters
id
required
string <uuid>

ID of user

Request Body schema: application/json
required

User request body

name
string
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "name": "John Doe",
  • "username": "johndoe",
  • "password": "somesecrethash"
}

Delete an existing user

Delete an existing user

Authorizations:
basicAuth
path Parameters
id
required
string <uuid>

ID of user

Responses

Sharing

Sharing Albums or MediaItems

Get an existing shared album

Get an existing shared album

path Parameters
id
required
string <uuid>

ID of shared album

Responses

Response samples

Content type
application/json
{
  • "id": "102dc522de-1669-48a4-8270-4950a0237599",
  • "userId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "name": "Jane's Wedding",
  • "description": "Pictures from Wedding of Jane and Doe",
  • "coverMediaItemId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "shared": true,
  • "hidden": false,
  • "mediaItemsCount": 42,
  • "createdAt": "2022-09-14T16:58:28Z",
  • "updatedAt": "2022-09-14T16:58:28Z",
  • "coverMediaItem": {
    }
}

Get mediaItems of an existing shared album

Get mediaItems of an existing shared album

path Parameters
id
required
string <uuid>

ID of shared album

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Jobs

Background jobs for your MediaItems

Get all existing jobs

Get all existing jobs

Authorizations:
bearerAuth
query Parameters
page
number
Default: 1

Pagination page

limit
number
Default: 15

Pagination limit

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new job

Create a new job

Authorizations:
bearerAuth
Request Body schema: application/json
required

Job request body

components
string

Responses

Request samples

Content type
application/json
{
  • "components": "metadata,faces"
}

Get an existing job

Get an existing job

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of job

Responses

Response samples

Content type
application/json
{
  • "id": "102dc522de-1669-48a4-8270-4950a0237599",
  • "userId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "components": "metadata, faces",
  • "status": "SCHEDULED",
  • "lastMediaItemId": "102dc522de-1669-48a4-8270-4950a0237599",
  • "createdAt": "2022-09-14T16:58:28Z",
  • "updatedAt": "2022-09-14T16:58:28Z"
}

Update an existing job

Update an existing job

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

ID of job

Request Body schema: application/json
required

job request body

status
string
Enum: "SCHEDULED" "RUNNING" "PAUSED" "COMPLETED" "STOPPED"

Responses

Request samples

Content type
application/json
{
  • "status": "PAUSED"
}

Get version of Smriti

Get version of Smriti

Responses

Response samples

Content type
application/json
{
  • "version": "24.06.15",
  • "gitSha": "addf120b430021c36c232c99ef8d926aea2acd6b"
}

Get disk usage of Smriti

Get disk usage of Smriti

Responses

Response samples

Content type
application/json
{
  • "total": 93896515584,
  • "free": 58737410048,
  • "used": 35159105536
}

Get list of enabled features

Get list of enabled features

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "favourites": true,
  • "hidden": false
}

Search existing mediaItems

Search existing mediaItems

Authorizations:
bearerAuth
query Parameters
q
string
Example: q=pizza

Search Query

Responses

Response samples

Content type
application/json
[
  • {
    }
]