Metadata
Available metadata
Metadata provides additional layers of information about a production, encompassing details beyond just the primary content. When users generate prompts, the search mechanism can leverage this metadata to refine search results, ensuring that the returned productions are not just contextually but also categorically aligned with the user's intent.
Below is the list of officially supported metadata. Please note that while they are supported, it’s the providers responsibility to add and maintain them into the productions.
Publication year
This metadata provides the year when a production was first published:
{
"publication_year": 2019
}
Production status
This metadata provides insights into the current state of a production:
{
"status": {
"current_status": "In production",
"last_updated": "2021-01-01",
"notes": "Production is on schedule."
}
}
current_status
: Represents the current phase of the production. Its value must be one of the predefined statuses in the API documentation.last_updated
: A string indicating the date when the status was last updated, typically formatted as "YYYY-MM-DD".notes
: An optional field that can include additional comments or details about the production's current status.
Reviews & Ratings
This metadata defines three main fields related to production feedback and audience scale:
{
"reviews": [
{
"rating": 6,
"count": 1019,
"popularity": 8
}
]
}
- rating: Represents the average score given by audiences or critics, ranging between 0 and 10.
- count: Indicates the total number of reviews. It defaults to 0 and can't be negative.
- popularity: Measures the production's audience size on a scale from 0 (indicating the smallest audience size) to 10 (indicating the largest audience size).
Extra
The Extra metadata allows providers to add any more metadata they want, for instance to a specific third party application usage. There are no official specification except the parent name.