Metadata Autofill API

AS
Last updated 7 days ago

The Metadata Autofill API provides a CSL-JSON response when you provide it with the specific website, book, or movie.

post
Autofill

https://api.cloudcite.net
/autofill
Request
Response
Headers
x-api-key
required
string
Your API Key
Body Parameters
Request
required
object
Use the request formats below
200: OK
It worked!
304: Not Modified
The response you have cached hasn't changed.
400: Bad Request
401: Unauthorized
403: Forbidden
404: Not Found
422: Unprocessable Entity
You are missing a required field in the request body.
500: Internal Server Error
Something went wrong. Check the request body you sent us.

Websites

Autofill requires the following fields to be sent in the body of the POST request:

CSL-JSON Data Request
{
"url": "https://www.theguardian.com/news/2018/jun/29/the-great-firewall-of-china-xi-jinpings-internet-shutdown",
"format": "website",
"id": "CITATION-1"
}

Here's how it will respond:

CSL-JSON Data Response
{
"issued": {
"month": "6",
"year": "2018",
"day": "29"
},
"id": "CITATION-1",
"author": [{
"given": "Elizabeth C",
"family": "Economy"
}],
"title": "The great firewall of China: Xi Jinping’s internet shutdown",
"publisher": "Guardian News and Media Limited",
"source": "the Guardian",
"URL": "https://www.theguardian.com/news/2018/jun/29/the-great-firewall-of-china-xi-jinpings-internet-shutdown",
"abstract": "The long read: Before Xi Jinping, the internet was becoming a more vibrant political space for Chinese citizens. But today the country has the largest and most sophisticated online censorship operation in the world",
"type": "webpage"
}

Books

Autofill requires the following fields to be sent in the body of the POST request. The "book" field is the unique ID Google Books assigns to the volume. You may make a search request to get the unique ID. You can search using ONE of the following: title, ISBN, OCLC, LCCN, author name, or publisher name.

CSL-JSON Data Request
Search Request
{
"title": "The Street Car Named Desire",
"book": "44qi9P-COd4C",
"format": "book"
}

Here's how it will respond:

CSL-JSON Data Response
Search Response
{
"issued": {
"month": null,
"year": "1953",
"day": null
},
"id": "SET",
"author": [{
"given": "Tennessee",
"family": "Williams"
}],
"editor": [],
"collection-editor": [],
"translator": [],
"edition": null,
"language": "English",
"title": "A Streetcar Named Desire",
"title-short": null,
"publisher": "Dramatists Play Service Inc",
"publisher-place": null,
"ISBN": "9780822210894",
"number-of-pages": 107,
"number-of-volumes": null,
"source": null,
"URL": null,
"dimensions": "20.00 cm x 12.70 cm x 0.60 cm",
"abstract": "THE STORY: The play reveals to the very depths the character of Blanche du Bois, a woman whose life has been undermined by her romantic illusions, which lead her to reject--so far as possible--the realities of life with which she is faced and which s",
"collection-title": null,
"type": "book"
}

Movie

Autofill requires the following fields to be sent in the body of the POST request. You can use the page property to access multiple pages of movies. Once you have chosen a movie, send the ID in the movie property.

CSL-JSON Data Movie Request
Search Movie Response
{
"title": "Avengers Age of Ultron",
"format": "movie",
"movie": "99861"
}

Here's how it will respond:

CSL-JSON Data Movie Response
Search Movie Response
{
"issued": {
"month": "04",
"year": "2015",
"day": "22"
},
"id": "SET",
"director": [{
"given": "Joss",
"family": "Whedon"
}],
"title": "Avengers: Age of Ultron",
"publisher": "Marvel Studios",
"publisher-place": "United States of America",
"source": null,
"abstract": "When Tony Stark tries to jumpstart a dormant peacekeeping program, things go awry and Earth’s Mightiest Heroes are put to the ultimate test as the fate of the planet hangs in the balance. As the villainous Ultron emerges, it is up to The Avengers to stop him from enacting his terrible plans, and soon uneasy alliances and unexpected action pave the way for an epic and unique global adventure.",
"type": "motion_picture"
}

Music

Autofill requires the following fields to be sent in the body of the POST request. Music has the following types: album, song, and song-in-album. You can use song-in-album once you have chosen the collectionId of the album you want the songs for. You can use the trackId of the song once you have chosen the song you want the CSL-JSON data for.

CSL-JSON Data Song Request
CSL-JSON Data Album Request
Search Album Request
Search Song Request
Search Song-in-Album Request
{
"title": "In My Feelings",
"format": "music",
"type": "song",
"song": "1418213402"
}

Here's how it will respond:

CSL-JSON Data Song Response
CSL-JSON Data Album Response
Search Album Response
Search Song Response
Search Song-in-Album Response
{
"issued": {
"month": "6",
"year": "2018",
"day": "29"
},
"id": "SET",
"author": [{
"given": "Drake"
}],
"composer": [],
"editor": [],
"edition": null,
"language": null,
"title": "In My Feelings",
"title-short": null,
"publisher": null,
"publisher-place": null,
"source": null,
"URL": null,
"abstract": null,
"collection-title": "Scorpion",
"genre": "Hip-Hop/Rap",
"type": "song"
}

Podcast

Autofill requires the following fields to be sent in the body of the POST request.

Autofill currently does not parse the feed url provided to provide specific information about podcast episodes in the CSL Data format.

CSL-JSON Data Podcast Request
CSL-JSON Data Episode Request
Search Podcast Request
Search Episode Request
{
"title": "Stuff You Should Know",
"format": "podcast",
"type": "podcast",
"podcast": "278981407"
}

Here's how it will respond:

CSL-JSON Data Podcast Response
CSL-JSON Data Episode Response
Search Podcast Response
Search Episode Response
{
"issued": {
"month": "7",
"year": "2018",
"day": "31"
},
"id": "SET",
"author": [{
"given": "HowStuffWorks"
}],
"composer": [],
"editor": [],
"edition": null,
"language": null,
"title": "Stuff You Should Know",
"title-short": null,
"publisher": null,
"publisher-place": null,
"source": null,
"URL": null,
"abstract": null,
"collection-title": "Stuff You Should Know",
"genre": "Society & Culture",
"type": "song"
}

TV Show

TV Shows are not currently supported by autofill. We expect to add support for this soon.

Journal

Journals are not currently supported by autofill. We expect to add support for this soon.

Digital Image

Digital images are not currently supported by autofill. We expect to add support for this soon.

Other Formats

Definitions by Zotero. Formats marked in bold are supported by CloudCite's Autofill API.

Item Type

Description

Artwork

A piece of artwork (e.g., an oil painting, photograph, or sculpture). Also use this item type for other types of images or visual items (e.g., scientific figures).

Audio Recording

Any form of audio recording, including music, spoken word, sound effects, archival recordings, or audio-based scientific figures.

Bill

A proposed piece of legislation.

Blog Post

An article or entry posted to a personal blog website. For online articles published as part of a larger online publication (e.g., NYT Blogs), using Magazine Article or Newspaper Article generally yields better results.

Book

A book or similar published item. For government documents, technical reports, manuals, etc., use Reportinstead. This item type can also be adapted to fit many types of unusual items.

Book Section

A section of a book. Usually chapters, but also forewords, prefaces, introductions, appendices, afterwords, comments, etc.

Case

A legal case, either published or unpublished.

Computer Program

A piece of software or other computer program.

Conference Paper

A paper presented at a conference and subsequently published in a formal conference proceedings publication (e.g., as a book, report, or issue of a journal). For conference papers that have not been published in a proceedings, use Presentation.

Dictionary Entry

An entry published as part of a dictionary.

Document

A generic document item. This item type has a poor selection of fields and poor support in citation styles, so it should generally be avoided.

Email

A message sent via email. This type could also be used for other forms of personal communication.

Encyclopedia Article

An article or chapter published as part of an encyclopedia.

Film

A film or motion picture. Generally, use this type for artistically-oriented films (including fictional, non-fictional, and documentary films). For other types of video items, use Video Recording.

Forum Post

A post on an online discussion forum. Also use this type for items such as Facebook posts or tweets.

Hearing

A formal hearing or meeting report by a legislative body.

Instant Message

A message sent via an instant message or chat service. This type could also be used for other forms of personal communication.

Interview

An interview with a person, including recordings, transcripts, or other records of the interview.

Journal Article

An article published in a scholarly journal (either print or online).

Letter

A letter sent between persons or organizations. This type could also be used for other forms of personal communication.

Magazine Article

An article published in a non-scholarly, popular, or trade magazine (either print or online).

Manuscript

An unpublished manuscript. Use this type for both historical documents and modern unpublished work (e.g., unpublished manuscripts, manuscripts submitted for publication, working papers that are not widely available). Can also be used for other forms of historical or archival documents. This item type can also be adapted to fit many types of unusual items.

Map

A map. Also use this type for geographic models.

Newspaper Article

An article published in a newspaper (either print or online).

Patent

A patent awarded for an invention.

Podcast

A podcast (an episode of an audio or video program distributed online, often via subscription).

Presentation

A presentation made as part of a conference, meeting, symposium, lecture, etc. This item type refers to the presentation itself, not a written version published as part of a conference proceedings (use Conference Paper for such published versions).

Radio Broadcast

An audio broadcast, such as a radio news show, an episode of a radio entertainment series, or similar. Includes broadcasts from online radio stations and audio broadcasts archived online (cf. Podcast).

Report

A report published by an organization, institution, government department, or similar entity. Also used for working papers and preprints distributed through institutional repositories or preprint servers. This item type can also be adapted to fit many types of unusual items.

Statute

A law or other piece of enacted legislation.

Thesis

A thesis submitted as part of a student applying for a degree (either published or unpublished).

TV Broadcast

An episode of a television series.

Video Recording

A video recording. Use this type for general video items that do not fit into one of the more specific video item types (e.g., Film, TV Broadcast), such as YouTube videos or video-based scientific figures.

Webpage

An online page of a website. When possible, use one of the more specific item types above (e.g., Magazine Article, Blog Post, Report).

Note

A standalone note.

Attachment

A standalone attachment file (e.g., a PDF, JPEG, DOCX, PPTX, XLSX, or ODT file).