Images

Images management endpoints.

post

Body

multipart/form-data

imagestring · binaryRequired

is_publicbooleanRequired

metadatastring · binaryRequired

Responses

200

Uploaded image with its metadata

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/api/images

HTTPcURLJavaScriptPython

POST /api/images HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 55

{
  "image": "binary",
  "is_public": true,
  "metadata": "binary"
}

{
  "currentImages": 1,
  "maxImages": 1,
  "image": {
    "id": "text",
    "isPublic": true,
    "metadata": {
      "dateTime": "text",
      "placeId": "text",
      "realm": "text",
      "scene": {
        "location": {
          "x": "text",
          "y": "text"
        },
        "name": "text"
      },
      "userAddress": "text",
      "userName": "text",
      "visiblePeople": [
        {
          "isEmoting": true,
          "isGuest": true,
          "userAddress": "text",
          "userName": "text",
          "wearables": [
            "text"
          ]
        }
      ]
    },
    "thumbnailUrl": "text",
    "url": "text"
  }
}

patch

Path parameters

idstringRequired

Body

application/json

is_publicbooleanRequired

Responses

200

Image visibility updated successfully

No content

403

Forbidden

404

Image was not found

500

Failed to update image visibility

patch

/api/images/{id}/visibility

HTTPcURLJavaScriptPython

PATCH /api/images/{id}/visibility HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "is_public": true
}

No content

get

Path parameters

image_idstringRequired

Responses

200

Get image

application/json

get

/api/images/{image_id}

HTTPcURLJavaScriptPython

GET /api/images/{image_id} HTTP/1.1
Host: 
Accept: */*

200

Get image

{
  "id": "text",
  "isPublic": true,
  "metadata": {
    "dateTime": "text",
    "placeId": "text",
    "realm": "text",
    "scene": {
      "location": {
        "x": "text",
        "y": "text"
      },
      "name": "text"
    },
    "userAddress": "text",
    "userName": "text",
    "visiblePeople": [
      {
        "isEmoting": true,
        "isGuest": true,
        "userAddress": "text",
        "userName": "text",
        "wearables": [
          "text"
        ]
      }
    ]
  },
  "thumbnailUrl": "text",
  "url": "text"
}

delete

Path parameters

image_idstringRequired

Image database id to delete

Responses

200

Image deleted

application/json

403

Forbidden

404

Image was not found

500

Failed to delete image

delete

/api/images/{image_id}

HTTPcURLJavaScriptPython

DELETE /api/images/{image_id} HTTP/1.1
Host: 
Accept: */*

{
  "currentImages": 1,
  "maxImages": 1
}

get

Path parameters

image_idstringRequired

Responses

200

Get image metadata

application/json

404

Not found

get

/api/images/{image_id}/metadata

HTTPcURLJavaScriptPython

GET /api/images/{image_id}/metadata HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "isPublic": true,
  "metadata": {
    "dateTime": "text",
    "placeId": "text",
    "realm": "text",
    "scene": {
      "location": {
        "x": "text",
        "y": "text"
      },
      "name": "text"
    },
    "userAddress": "text",
    "userName": "text",
    "visiblePeople": [
      {
        "isEmoting": true,
        "isGuest": true,
        "userAddress": "text",
        "userName": "text",
        "wearables": [
          "text"
        ]
      }
    ]
  },
  "thumbnailUrl": "text",
  "url": "text"
}

post

Query parameters

offsetinteger · int64Optional

limitinteger · int64Optional

Body

application/json

placesIdsstring[]Required

Responses

200

List images for multiple places

application/json

400

Invalid place IDs format

post

/api/places/images

HTTPcURLJavaScriptPython

POST /api/places/images HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "placesIds": [
    "text"
  ]
}

{
  "maxImages": 1,
  "images": []
}

get

Path parameters

place_idstringRequired

Query parameters

offsetinteger · int64Optional

limitinteger · int64Optional

Responses

200

List images for a given place

application/json

404

Not found

get

/api/places/{place_id}/images

HTTPcURLJavaScriptPython

GET /api/places/{place_id}/images HTTP/1.1
Host: 
Accept: */*

{
  "maxImages": 1,
  "images": [
    {
      "dateTime": "text",
      "id": "text",
      "isPublic": true,
      "thumbnailUrl": "text",
      "url": "text"
    }
  ]
}

get

Path parameters

user_addressstringRequired

Responses

200

Get user data

application/json

404

Not found

get

/api/users/{user_address}

HTTPcURLJavaScriptPython

GET /api/users/{user_address} HTTP/1.1
Host: 
Accept: */*

{
  "currentImages": 1,
  "maxImages": 1
}

get

Path parameters

user_addressstringRequired

Query parameters

offsetinteger · int64Optional

limitinteger · int64Optional

compactbooleanOptional

Responses

200

List images for a given user

application/json

210

List gallery images for a given user if compact=true (status code is 200, but was not possible to list multiple responses for one status code)

application/json

404

Not found

get

/api/users/{user_address}/images

HTTPcURLJavaScriptPython

GET /api/users/{user_address}/images HTTP/1.1
Host: 
Accept: */*

{
  "currentImages": 1,
  "maxImages": 1,
  "images": [
    {
      "id": "text",
      "isPublic": true,
      "metadata": {
        "dateTime": "text",
        "placeId": "text",
        "realm": "text",
        "scene": {
          "location": {
            "x": "text",
            "y": "text"
          },
          "name": "text"
        },
        "userAddress": "text",
        "userName": "text",
        "visiblePeople": [
          {
            "isEmoting": true,
            "isGuest": true,
            "userAddress": "text",
            "userName": "text",
            "wearables": [
              "text"
            ]
          }
        ]
      },
      "thumbnailUrl": "text",
      "url": "text"
    }
  ]
}