Entities

Get one entity with its sheets, looks, links and facets

The entity, its reference set with signed URLs, its baked sheet and items_sheet (baked on this read when its views changed — free; see EntitySheet), a character's looks, its links both ways, and facets — the other entities it has been photographed with, by how many scans they share. photo_count is not repeated here; facets[].count is the number that matters.

For a video, prefer sheet.asset_id as the reference when the sheet is ready: one image carries every view.

Somebody else's id answers 404, not 403: the API does not confirm that another user's row exists.

get/v1/entities/{id}

Request

Base URL: https://nanostudiopro.com/api
URL: https://nanostudiopro.com/api/v1/entities/{id}
Auth: HTTP bearer

Response

The entity, its sheets, looks, links and facets

idstring

namestring

slugstring

kind'character' | 'prop' | 'location' | 'look' | 'skin'

parent_idstring nullable

A look's character; null for every other kind.

photo_countinteger

Distinct scans this entity is tagged on — what the app calls photos. OPTIONAL because it is a list-only field: GET /v1/entities/{id} leaves the key out rather than returning a zero, since there facets[].count is the number that matters and recounting would cost the detail view a query it never asked for.

created_atstring date-time

Example response

{
  "id": "cmod4q3op00011dod8a0omywd",
  "name": "Pancho",
  "slug": "pancho",
  "photo_count": 12,
  "bio": {
    "born": "1983"
  },
  "specs": {
    "fields": [
      {
        "key": "top_speed",
        "label": "Top speed",
        "value": "250 km/h"
      }
    ]
  },
  "looks": [
    {
      "name": "Battle armor"
    }
  ],
  "links": [
    {
      "relation": "carries",
      "label": "carries",
      "to": {
        "type": "prop",
        "name": "Katana"
      }
    }
  ],
  "facets": [
    {
      "entity_type": "character"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.