API Reference — mymind

The entity model

Entity type names follow the Schema.org vocabulary, expressed with JSON-LD-style @type (the type discriminator) and @id keys.

Since @type may be a single string or an array, write clients to handle both — normalize to an array (or check membership) rather than assuming a single value.

Property	Type	Description
@type	string \| string[]	Type name(s) for this entity, from the Schema.org vocabulary — a single type, or an array when the entity is several types at once (multi-typed nodes, as JSON-LD allows). See Type Identifiers below.
@id?	string	mymind's internal identifier for the entity — not a public or canonical id. Present only when the entity is a well-known public object (e.g. a recognized book, film, product, or social post); absent otherwise.

Type identifiers

Apartment, Article, AudioObject, BlueSkyPost, Book, Brand, Business, Document, FacebookReel, Flight, FlightReservation, House, ImageObject, InstagramPost, InstagramReel, Media, Model, Movie, MusicAlbum, MusicPlaylist, MusicRecording, MusicRelease, MusicVideo, Note, Painting, Palette, Periodical, Person, Photograph, Place, Podcast, PodcastEpisode, PodcastSeason, Product, Quotation, RealEstateListing, Recipe, RedditPost, Repository, RepositoryIssue, Restaurant, ScholarlyArticle, Screenshot, SoftwareApplication, SubstackNote, TedTalk, ThreadsPost, TikTokPost, TVEpisode, TVSeason, TVSeries, Typeface, VideoGame, VideoObject, VimeoVideo, WebPage, WikipediaArticle, XPost, YouTubeVideo

Extended properties

Each entity type adds its own properties on top of the base model. The sections below document type-specific fields. Shared sub-types referenced by multiple entities (Actor, Address, etc.) are listed together at the end.

Apartment WIP

Property	Type	Description
offers	Offer[]	Available offers.
address	Address	Street address.
url	Url	Listing URL.

Article WIP

Property	Type	Description
title	string	Article headline.
author	Actor	The author.
published	Timestamp	When the article was published.
publisher	Actor	The publisher.
content	Content	The content body.
url	Url	Article URL.

AudioObject WIP

Property	Type	Description
title	string	Audio title.
duration	IsoDuration	Duration.
url	Url	Audio URL.

BlueSkyPost WIP

Property	Type	Description
author	Actor	The author.
content	Content	The content body.
url	Url	Post URL.

Book

Property	Type	Description
title	string	Book title.
authors	Actor[]	The authors.
isbn	ISBN	ISBN-13 identifier.
publisher	Actor	The publisher.
published	Timestamp	Publication date.
offers	Offer[]	Available offers.
url	Url	Book URL.

Brand WIP

Property	Type	Description
name	string	Brand name.

Business WIP

Property	Type	Description
name	string	Business name.
address	Address	Street address.
phoneNumber	string	Phone number.
url	Url	Website URL.

Document WIP

Property	Type	Description
title	string	Document title.
format	string	File format, e.g. `pdf`, `docx`.
url	Url	Document URL.

FacebookReel WIP

Property	Type	Description
author	Actor	The author.
image	ImageObject	Cover image for the reel.
url	Url	Reel URL.

Flight WIP

Property	Type	Description
airline	Airline	The airline.
flightNumber	string	Flight number.
departure	Airport	Departure airport.
arrival	Airport	Arrival airport.
departureTime	Timestamp	Scheduled departure time.
arrivalTime	Timestamp	Scheduled arrival time.

FlightReservation WIP

Property	Type	Description
confirmationNumber	string	Booking confirmation code.
flight	EntityReference	Reference to the flight entity.

House WIP

Property	Type	Description
name	string	Listing title.
offers	Offer[]	Available offers.
address	Address	Street address.
bedrooms	integer	Number of bedrooms.
bathrooms	integer	Number of bathrooms.
url	Url	Listing URL.

ImageObject WIP

Property	Type	Description
width	integer	Width in pixels.
height	integer	Height in pixels.
format	string	Image format, e.g. `jpeg`, `png`, `webp`.
url	Url	Image URL.

InstagramPost WIP

Property	Type	Description
author	Actor	The author.
content	Content	The content body.
url	Url	Post URL.

InstagramReel

Property	Type	Description
author	Actor	The author.
image	ImageObject	Cover image for the reel.
url	Url	Reel URL.

Media WIP

Property	Type	Description
format	string	Media format or MIME type.
duration	IsoDuration	Duration.
url	Url	Media URL.

Model WIP

Property	Type	Description
title	string	Model title.
format	string	3D format, e.g. `glb`, `obj`, `usdz`.
url	Url	Model URL.

Movie

Property	Type	Description
title	string	Movie title.
directors	Actor[]	The directors.
published	Timestamp	Release date.
duration	IsoDuration	Duration.

MusicAlbum WIP

Property	Type	Description
title	string	Album title.
artist	Actor	The artist.
published	Timestamp	Release date.
tracks	Track[]	Album tracks.

Track

Property	Type	Description
title	string	Track title.
number	integer	Track number.
duration	IsoDuration	Duration.

MusicPlaylist WIP

Property	Type	Description
title	string	Playlist title.
tracks	Track[]	Playlist tracks.
url	Url	Playlist URL.

MusicRecording WIP

Property	Type	Description
title	string	Track title.
artist	Actor	The artist.
album	EntityReference	Reference to the parent album entity.
duration	IsoDuration	Duration.

MusicVideo WIP

Property	Type	Description
title	string	Video title.
artist	Actor	The artist.
duration	IsoDuration	Duration.
url	Url	Video URL.

MusicRelease WIP

Property	Type	Description
title	string	Release title.
artist	Actor	The artist.
kind	string	Release type, e.g. `Single`, `Album`, `EP`.
published	Timestamp	Release date.
url?	Url	Release URL.

Note WIP

Property	Type	Description
content	Content	The content body.

Painting WIP

Property	Type	Description
title	string	Painting title.
artist	Actor	The artist.
published	Timestamp	When the painting was created.
medium	string	Medium, e.g. `oil on canvas`.

Palette WIP

Property	Type	Description
colors	Color[]	Palette colors.

Periodical WIP

Property	Type	Description
name	string	Publication name.
url	Url	Publication URL.

Person WIP

A person — alive, dead, undead, or fictional.

Property	Type	Description
name	string	Full name.
url	Url	Profile or homepage URL.

Photograph WIP

Property	Type	Description
title	string	Photograph title.
author	Actor	The author.
url	Url	Image URL.

Place WIP

Property	Type	Description
name	string	Place name.
address	Address	Street address.

Podcast WIP

Property	Type	Description
title	string	Podcast title.
author	Actor	The author.
url	Url	Podcast URL.

PodcastEpisode WIP

Property	Type	Description
title	string	Episode title.
podcast	EntityReference	Reference to the parent podcast entity.
duration	IsoDuration	Duration.
published	Timestamp	Publication date.
url	Url	Episode URL.

PodcastSeason WIP

Property	Type	Description
title	string	Season title.
podcast	EntityReference	Reference to the parent podcast entity.
number	integer	Season number.

Product

Property	Type	Description
name	string	Product name.
offers	Offer[]	Available offers.
brand	Brand	The brand.
url	Url	Product URL.

Quotation WIP

Property	Type	Description
author	Actor	The author.
content	Content	The content body.

RealEstateListing WIP

Property	Type	Description
name	string	Listing title.
offers	Offer[]	Available offers.
address	Address	Street address.
property	EntityReference	Reference to the property entity (Apartment, House, etc.).
url	Url	Listing URL.

Recipe WIP

Property	Type	Description
title	string	Recipe title.
author	Actor	The author.
ingredients	RecipeIngredient[]	List of ingredients.
instructions	RecipeInstruction[]	Step-by-step instructions.
cookTime	IsoDuration	Cook time.
prepTime	IsoDuration	Prep time.
url	Url	Recipe URL.

RecipeIngredient

Property	Type	Description
@id?	string	Internal identifier for the ingredient, when it's a recognized public object.
name	string	Ingredient name.
quantity	number	Amount required.

RecipeInstruction

Property	Type	Description
text	string	The instruction text.

RedditPost WIP

Property	Type	Description
author	Actor	The author.
subreddit	string	Subreddit name.
published	Timestamp	Publication date.
url	Url	Post URL.

Repository

Property	Type	Description
license	License	Repository license.
owner	Actor	Repository owner.
url	Url	Repository URL.

RepositoryIssue WIP

Property	Type	Description
title	string	Issue title.
number	integer	Issue number.
state	string	Issue state, e.g. `open`, `closed`.
author	Actor	The author.
repository	EntityReference	Reference to the parent repository entity.
url	Url	Issue URL.

Restaurant WIP

Property	Type	Description
name	string	Restaurant name.
address	Address	Street address.
phoneNumber	string	Phone number.
url	Url	Website URL.

ScholarlyArticle WIP

Property	Type	Description
title	string	Paper title.
author	Actor	The author.
published	Timestamp	Publication date.
journal	Periodical	The journal.
doi	string	DOI identifier.
url	Url	Paper URL.

Screenshot WIP

Property	Type	Description
width	integer	Width in pixels.
height	integer	Height in pixels.
url	Url	Image URL.

SoftwareApplication WIP

Property	Type	Description
name	string	Application name.
platform	Platform	The platform.
url	Url	Application URL.

SubstackNote WIP

Property	Type	Description
author	Actor	The author.
published	Timestamp	Publication date.
url	Url	Note URL.

TedTalk WIP

Property	Type	Description
title	string	Talk title.
speaker	Actor	The speaker.
duration	IsoDuration	Duration.
url	Url	Talk URL.

ThreadsPost WIP

Property	Type	Description
author	Actor	The author.
content	Content	The content body.
url	Url	Post URL.

TikTokPost WIP

Property	Type	Description
author	Actor	The author.
url	Url	Video URL.

TVEpisode

Property	Type	Description
title	string	Episode title.
series	EntityReference	Reference to the parent TV series entity.
season	TVEpisodeSeason	The season this episode belongs to.
number	integer	Episode number.
duration	IsoDuration	Duration.
url?	Url	Episode URL.

TVEpisodeSeason

Property	Type	Description
@id?	string	Internal identifier of the parent season entity, when it's a recognized public object.
number	integer	Season number.

TVSeason WIP

Property	Type	Description
title	string	Season title.
series	EntityReference	Reference to the parent TV series entity.
number	integer	Season number.
episodes	EntityReference[]	Episodes in the season.
url?	Url	Season URL.

TVSeries WIP

Property	Type	Description
title	string	Series title.
seasons	EntityReference[]	Seasons in the series.

Typeface WIP

Property	Type	Description
name	string	Typeface name.
foundry	Actor	The type foundry.
designer?	Actor	The type designer.

VideoGame

Property	Type	Description
title	string	Game title.
developer	Actor	The developer.
publisher	Actor	The publisher.
platform	Platform	The platform.
published	Timestamp	Release date.
url?	Url	Game URL.

VideoObject WIP

Property	Type	Description
title	string	Video title.
duration	IsoDuration	Duration.
url	Url	Video URL.

VimeoVideo WIP

Property	Type	Description
title	string	Video title.
author	Actor	The author.
duration	IsoDuration	Duration.
url	Url	Video URL.

WebPage WIP

Property	Type	Description
title	string	Page title.
site	Site	The source site.
url	Url	Page URL.

WikipediaArticle WIP

Property	Type	Description
title	string	Article title.
language	string	Wikipedia language code, e.g. `en`.
url	Url	Article URL.

XPost

Property	Type	Description
content	Content	The content body.
author	Actor	The author.
published	Timestamp	Publication date.
attachments	BlobReference[]	Images or videos attached to the post.
url	Url	Post URL.

YouTubeVideo WIP

Property	Type	Description
title	string	Video title.
author	Actor	The author.
duration	IsoDuration	Duration.
url	Url	Video URL.

Shared sub-types

These sub-types are referenced by multiple entity types above.

Actor

Property	Type	Description
name	string	Display name — a person, author, publisher, or organization.

Address

Property	Type	Description
street	string	Street address.
city	string	City name.
region	string	State, province, or region.
postalCode	string	Postal or ZIP code.
country	Country	Country.

Airline

Property	Type	Description
name	string	Airline name.
iata	string	IATA airline code, e.g. `AA`, `UA`.

Airport

Property	Type	Description
name	string	Airport name.
code	string	IATA airport code, e.g. `LAX`, `JFK`.

Country

Property	Type	Description
name	string	Country name.
code	string	ISO 3166-1 alpha-2 code, e.g. `US`, `GB`.

Language

Property	Type	Description
name	string	Language name.
code	string	ISO 639-1 code, e.g. `en`, `fr`.

License

Property	Type	Description
name	string	Display name of the license.

Platform

Property	Type	Description
name	string	Platform name.

Site

Property	Type	Description
name	string	Site name.
domain	string	Domain name, e.g. `example.com`.

Actions

Get an entity

Retrieves a single entity by its ID.

GET /entities/:id WIP 1 credit

Path parameters

Parameter	Type	Description
id	Uid	Entity to retrieve.

Response 200 OK

{
  "@type": "Brand",
  "@id": "c3D4e5F6g7H8i9J0k1L2m3"
}

Entities