ART19 Content API Documentation
The ART19 Content API conforms to the [JSON:API specification](http://jsonapi.org). API requests MUST use the HTTP Accept header: Accept:…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The ART19 Content API conforms to the JSON:API specification.
API requests MUST use the HTTP Accept header:
Accept: application/vnd.api+json
API requests MUST be authenticated using the HTTP Authorization header:
Authorization: Token token="your-token", credential="your-credential"
General Notes
Some query parameters use unencoded [ and ] characters simply for readability. Defaults, examples, and
possible values are additionally rendered in double quotes for readability. In practice, query parameters should
not have quotes around the values (e.g., foo=bar is valid, not foo="bar"), and both query parameter keys
and values must be percent-encoded, per the requirements in RFC 3986 § 3.4.
Rate Limiting
In order to provide a fair distribution of available resources, all API calls are subject to rate limits.
If you exceed the number of API calls per minute granted to your credential, a 429 Too Many Requests
error response will be returned.
In that case, a Retry-After header MAY be included in the response, describing the number of seconds
after which a request can be retried.
If you run into a high number of 429 errors, please reach out to ART19 Support to adjust your rate limit.
Example
In the following example the request can be retried after waiting for 21 seconds:
HTTP/1.1 429 Too Many Requests
Content-Type: text/html
Retry-After: 21
Pagination
Requests to collection endpoints SHOULD provide pagination parameters.
Some endpoints REQUIRE pagination parameters to be provided.
Whenever pagination is provided, it MUST be valid.
Failing to provide pagination when it is required or providing wrong or incomplete pagination
always results in a 400 Bad Request error response.
The page numbering starts with 1 and the maximum page size (if not otherwise documented
on an endpoint) is 100. Pagination MUST NOT be specified if requesting a list of IDs (using an ids[] parameter).
Providing invalid values for page number or page size, as well as providing only a page number or only a page size,
is considered an error. Pagination is provided like this:
page[number]=1&page[size]=25
Responses conform to the JSON:API specification's pagination section
by including pagination links. Your requested page size will be carried into the pagination links.
Sorting
Requests to collection endpoints usually accept a sort parameter. Please refer to the
JSON:API Specification's sorting section for further details.
Relationship Linking
Currently, resources return all of their relationships, in no particular order, pursuant to how relationships
should be returned according to the JSON:API specification. Consumers of this API
MUST NOT make assumptions about the order of these collections. Even though this data is not currently paginated, consumers MUST support
paginating relationships per the JSON:API specification if this data is important for their application.
Endpoints 22
ClassificationInclusion
- GETGet ClassificationInclusion records
/classification_inclusions?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&classification_id=a90609c0-9f0c-48fd-8a41-83eb8414bedb&classification_type=AlternateFeedType&classified_id=fee1976e-f1bc-48a9-9ee8-58800f4d3462&classified_type=Series&q=string&sort=created_atClassification Inclusions connect classifications with entities like series, episodes, or campaigns, amongst others. In order to retrieve a set of… - GETGet a specific classification inclusion
/classification_inclusions/:id
Classification
- GETGet a list of classifications
/classifications?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&type=Genre&q=string&is_country=true&sort=value - GETGet a specific classification
/classifications/:id
Credit
- GETGet a list of credits
/credits?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&creditable_id=76654e16-76ce-4945-92e9-e0a381917853&creditable_type=Series&sort=position - GETGet a specific credit
/credits/:id
Episode
- GETGet a list of episodes
/episodes?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&included_in_inventory_calendar=b97239ef-1776-489a-a1df-5f70a8407148&month=string&published=true&q=string&released_after=2024-01-01T00:00:00Z&released_before=2024-01-01T00:00:00Z&rss=true&season_id=30e7b568-d099-486b-9a8e-51b7594cab7d&series_id=d0ceb1ff-b95b-4c1e-a7e5-a36ed7b4d3b7&sort=sort_title&year=stringOne initial filter must be provided (ids, series_id, or season_id), otherwise a 400 Bad Request response will be returned. Additional filters are allowed.… - GETGet a specific episode
/episodes/:id - GETGet the episode released right after the specified one
/episodes/:id/next_sibling?rss=true - GETGet the episode released right before the specified one
/episodes/:id/previous_sibling?rss=true
Image
- GETGet a list of images
/images?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6An image represents a piece of artwork attached to some entity like a series, season, or episode, and is _owned_ by an entity called the bucket. An image is… - GETGet a specific image
/images/:idAn image represents a piece of artwork attached to some entity like a series, season, or episode, and is _owned_ by an entity called the bucket. An image is…
MediaAsset
- GETGet a list of media assets
/media_assets?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6A media asset is part of a collection of assets or files representing an image or a piece of audio content like an episode or an ad. Images, for example, have… - GETGet a specific media asset
/media_assets/:idA media asset is part of a collection of assets or files representing an image or a piece of audio content like an episode or an ad. Images, for example, have…
Network
- GETGet a list of networks
/networks?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&q=string&ad_rep_account_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&ad_deal_status=active&sort=nameDeprecations The attribute cover_image_id has been replaced with the relationship cover_image and will be removed from the response in a future release. - GETGet a specific network
/networks/:idDeprecations The attribute cover_image_id has been replaced with the relationship cover_image and will be removed from the response in a future release.
Person
- GETGet a list of people
/people?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&q=string&sort=last_name,first_nameEach series, season, and episode has a Credits section where you may add people and roles. This is an internal tool to recognize contributors. It is not… - GETGet a specific person
/people/:idEach series, season, and episode has a Credits section where you may add people and roles. This is an internal tool to recognize contributors. It is not…
Season
- GETGet a list of seasons
/seasons?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&series_id=7ebd702d-07c8-4da9-a7a8-cf18ec414d5c&q=string&sort=sort_titleWhen retrieving a list of seasons, the result is automatically filtered depending on the privileges the used credential holds. If there are no specific… - GETGet a specific season
/seasons/:id
Series
- GETGet a list of series
/series?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&ad_rep_account_id=35eb02fc-54db-4650-98e0-4695b101b71d&network_id=5317358a-527e-4365-a343-361854286cc7&q=string&sort=sort_titleWhen retrieving a list of series, the result is automatically filtered depending on the privileges the used credential holds. All credentials will have access… - GETGet a specific series
/series/:id
API details
- Base URL
https://art19.com- Authentication
- An API key in the Authorization header
- Operations
- 22 operations on 22 pathsGET 22
- Main resources
- Episode 4Classification 2ClassificationInclusion 2Credit 2Image 2MediaAsset 2Network 2Person 2Season 2Series 2
- Response formats
application/vnd.api+json- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ART19 Content API Documentation in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ART19 Content API Documentation collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get ClassificationInclusion records” (GET /classification_inclusions?ids[]=3fa85f64-5717-4562-b3fc-2c963f66afa6&page[number]=1&page[size]=1&classification_id=a90609c0-9f0c-48fd-8a41-83eb8414bedb&classification_type=AlternateFeedType&classified_id=fee1976e-f1bc-48a9-9ee8-58800f4d3462&classified_type=Series&q=string&sort=created_at), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ART19 Content API Documentation?
The ART19 Content API conforms to the [JSON:API specification](http://jsonapi.org). API requests MUST use the HTTP Accept header: Accept:… It is listed under Media & content and has 22 endpoints.
Who publishes the ART19 Content API Documentation?
It is listed from Art19's public API description (an OpenAPI document), not published by Art19 on Swastik Codes. Anyone who controls art19.com can claim the profile by adding a DNS TXT record.
What is the base URL of the ART19 Content API Documentation?
Requests go to https://art19.com. Endpoint paths are added to this base URL.
How do I authenticate with the ART19 Content API Documentation?
With an API key in the Authorization header.
How many endpoints does the ART19 Content API Documentation have?
22 operations on 22 paths (22 GET). The largest groups are Episode, Classification, ClassificationInclusion, Credit.
Is forking the ART19 Content API Documentation free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.