Entities Coming soon
Entities are the real-world things behind your objects — the book inside a book cover photo, the product behind a shopping URL, the place tagged in a screenshot. An object's entities are accessible via object.entities, and entities can be fetched directly by ID.
Work in progress
This page documents the entity model under active development. Type identifiers, property shapes, and the GET /entities/:id endpoint may all change before launch — don't ship integrations against this surface yet.
The entity model
| Property |
Type |
Description |
| id |
Uid |
Unique identifier for the entity. |
| type |
string |
Type name for this entity. See Type Identifiers below. |
Type identifiers
Apartment,
Article,
AudioObject,
BlueSkyPost,
Book,
Brand,
Business,
Document,
FacebookReel,
Flight,
FlightReservation,
House,
Human,
ImageObject,
InstagramPost,
InstagramReel,
Media,
Model,
Movie,
MusicAlbum,
MusicPlaylist,
MusicRecording,
MusicRelease,
MusicVideo,
Note,
Painting,
Palette,
Periodical,
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, Brand, etc.) are listed together at the end.
Apartment
| Property | Type | Description |
|---|
| offers | Offer[] | Available offers. |
| address | Address | Street address. |
| url | Url | Listing URL. |
Article
| 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
| Property | Type | Description |
|---|
| title | string | Audio title. |
| duration | Duration | Duration. |
| url | Url | Audio URL. |
BlueSkyPost
| 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. |
Business
| Property | Type | Description |
|---|
| name | string | Business name. |
| address | Address | Street address. |
| phoneNumber | string | Phone number. |
| url | Url | Website URL. |
Document
| Property | Type | Description |
|---|
| title | string | Document title. |
| format | string | File format, e.g. pdf, docx. |
| url | Url | Document URL. |
FacebookReel
| Property | Type | Description |
|---|
| author | Actor | The author. |
| url | Url | Reel URL. |
Flight Coming soon
| 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 Coming soon
| Property | Type | Description |
|---|
| confirmationNumber | string | Booking confirmation code. |
| flight | EntityReference | Reference to the flight entity. |
House
| 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. |
Human Coming soon
| Property | Type | Description |
|---|
| name | string | Full name. |
| url | Url | Profile or homepage URL. |
ImageObject
| 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
| Property | Type | Description |
|---|
| poster | Actor | The poster. |
| content | Content | The content body. |
| url | Url | Post URL. |
InstagramReel
| Property | Type | Description |
|---|
| author | Actor | The author. |
| url | Url | Reel URL. |
| Property | Type | Description |
|---|
| format | string | Media format or MIME type. |
| duration | Duration | Duration. |
| url | Url | Media URL. |
Model
| 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 | Duration | Duration. |
MusicAlbum
| Property | Type | Description |
|---|
| title | string | Album title. |
| artist | Actor | The artist. |
| year | integer | Release year. |
| tracks | Track[] | Album tracks. |
Track
| Property | Type | Description |
|---|
| title | string | Track title. |
| number | integer | Track number. |
| duration | Duration | Duration. |
MusicPlaylist
| Property | Type | Description |
|---|
| title | string | Playlist title. |
| tracks | Track[] | Playlist tracks. |
| url | Url | Playlist URL. |
MusicRecording
| Property | Type | Description |
|---|
| title | string | Track title. |
| artist | Actor | The artist. |
| album | EntityReference | Reference to the parent album entity. |
| duration | Duration | Duration. |
MusicVideo
| Property | Type | Description |
|---|
| title | string | Video title. |
| artist | Actor | The artist. |
| duration | Duration | Duration. |
| url | Url | Video URL. |
MusicRelease
| Property | Type | Description |
|---|
| title | string | Release title. |
| artist | Actor | The artist. |
| kind | string | Release type, e.g. Single, Album, EP. |
| year | integer | Release year. |
| url? | Url | Release URL. |
Note
| Property | Type | Description |
|---|
| content | Content | The content body. |
Painting
| 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
| Property | Type | Description |
|---|
| colors | Color[] | Palette colors. |
Periodical
| Property | Type | Description |
|---|
| name | string | Publication name. |
| url | Url | Publication URL. |
Photograph
| Property | Type | Description |
|---|
| title | string | Photograph title. |
| author | Actor | The author. |
| url | Url | Image URL. |
Place
| Property | Type | Description |
|---|
| name | string | Place name. |
| address | Address | Street address. |
Podcast
| Property | Type | Description |
|---|
| title | string | Podcast title. |
| author | Actor | The author. |
| url | Url | Podcast URL. |
PodcastEpisode
| Property | Type | Description |
|---|
| title | string | Episode title. |
| podcast | EntityReference | Reference to the parent podcast entity. |
| duration | Duration | Duration. |
| published | Timestamp | Publication date. |
| url | Url | Episode URL. |
PodcastSeason
| 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
| Property | Type | Description |
|---|
| author | Actor | The author. |
| content | Content | The content body. |
RealEstateListing
| 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
RecipeIngredient
| Property | Type | Description |
|---|
| id | Uid | Ingredient identifier. |
| name | string | Ingredient name. |
| quantity | number | Amount required. |
RecipeInstruction
| Property | Type | Description |
|---|
| text | string | The instruction text. |
RedditPost
| 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
| 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
| Property | Type | Description |
|---|
| name | string | Restaurant name. |
| address | Address | Street address. |
| phoneNumber | string | Phone number. |
| url | Url | Website URL. |
ScholarlyArticle
| Property | Type | Description |
|---|
| title | string | Paper title. |
| author | Actor | The author. |
| published | Timestamp | Publication date. |
| journal | Actor | The journal. |
| doi | string | DOI identifier. |
| url | Url | Paper URL. |
Screenshot Coming soon
| Property | Type | Description |
|---|
| width | integer | Width in pixels. |
| height | integer | Height in pixels. |
| url | Url | Image URL. |
SoftwareApplication
| Property | Type | Description |
|---|
| name | string | Application name. |
| platform | Platform | The platform. |
| url | Url | Application URL. |
SubstackNote
| Property | Type | Description |
|---|
| author | Actor | The author. |
| published | Timestamp | Publication date. |
| url | Url | Note URL. |
TedTalk
| Property | Type | Description |
|---|
| title | string | Talk title. |
| speaker | Actor | The speaker. |
| duration | Duration | Duration. |
| url | Url | Talk URL. |
ThreadsPost
| Property | Type | Description |
|---|
| author | Actor | The author. |
| content | Content | The content body. |
| url | Url | Post URL. |
TikTokPost
| Property | Type | Description |
|---|
| poster | Actor | The poster. |
| 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 | Duration | Duration. |
| url? | Url | Episode URL. |
TVEpisodeSeason
| Property | Type | Description |
|---|
| id | Uid | Identifier of the parent season entity. |
| number | integer | Season number. |
TVSeason
| 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
| Property | Type | Description |
|---|
| title | string | Series title. |
| seasons | EntityReference[] | Seasons in the series. |
Typeface
| 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
| Property | Type | Description |
|---|
| title | string | Video title. |
| duration | Duration | Duration. |
| url | Url | Video URL. |
VimeoVideo
| Property | Type | Description |
|---|
| title | string | Video title. |
| author | Actor | The author. |
| duration | Duration | Duration. |
| url | Url | Video URL. |
WebPage
| Property | Type | Description |
|---|
| title | string | Page title. |
| site | Site | The source site. |
| url | Url | Page URL. |
WikipediaArticle
| Property | Type | Description |
|---|
| title | string | Article title. |
| language | string | Wikipedia language code, e.g. en. |
| url | Url | Article URL. |
XPost
| Property | Type | Description |
|---|
| author | Actor | The author. |
| published | Timestamp | Publication date. |
| content | Content | The content body. |
| url | Url | Post URL. |
YouTubeVideo
| Property | Type | Description |
|---|
| title | string | Video title. |
| author | Actor | The author. |
| duration | Duration | 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. |
Brand
| Property | Type | Description |
|---|
| name | string | Brand name. |
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. |
| 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.
Path parameters
| Parameter |
Type |
Description |
| id |
Uid |
Entity to retrieve. |
{
"id": "c3D4e5F6g7H8i9J0k1L2m3",
"type": "Brand"
}