Internet Archive Metadata
On this page
Internet Archive Metadata#
Metadata is data about data. In the case of Internet Archive items, the metadata describes the contents of the items. Metadata can include information such as the performance date for a concert, the name of the artist, and a set list for the event.
Metadata is a very important element of items in the Internet Archive. Metadata allows people to locate and view information. Items with little or poor metadata may never be seen and can become lost.
Note that metadata keys must be valid XML tags. Please refer to the XML Naming Rules section here.
All metadata for archive.org items are stored in <identifier>_meta.xml
and <identifier>_files.xml
.
The meta.xml file contains all of the item-level metadata for an item (e.g. title, description, creator, etc.).
The files.xml file contains all of the file-level metadata (e.g. track title, checksums, etc.).
While these two files are the canonical sources of metadata for archive.org items, most users will interact with an item’s metadata via the metadata API.
For example, nasa_meta.xml correlates to /metadata/nasa/metadata and nasa_files.xml to /metadata/nasa/files.
This document describes common metadata fields used on archive.org. Refer to the metadata API docs for more details on reading and writing metadata to items.
Archive.org Identifiers#
Each item at Internet Archive has an identifier.
An identifier is composed of a unique combination of alphanumeric characters (limited to ASCII), underscores (_
), dashes (-
), or periods (.
).
The first character of an identifier must be alphanumeric (e.g. it cannot start out with an underscore, dash, or period).
The maximum length of an identifier is 100 characters, but we generally recommend that identifiers be between 5 and 80 characters in length.
Identifiers must be unique across the entirety of Internet Archive, not simply unique within a single collection.
We prefer human-readable identifiers where possible, as they are more useful for library patrons. For example, consider using the title and/or creators of the item in your identifier, or some shortened form of them.
Once defined an identifier can not be changed. It will travel with the item or object and is involved in every manner of accessing or referring to the item.
Custom Metadata Fields#
Internet Archive strives to be metadata agnostic, enabling users to define the metadata format which best suits the needs of their material. In addition to the standard metadata fields listed above you may also define as many custom metadata fields as you require. These metadata fields can be defined ad hoc at item creation or metadata editing time and do not have to be defined in advance.
Metadata Schema#
Below are _meta.xml fields that have special meaning on archive.org.
access-restricted#
required: No
repeatable: No
internal use only: Yes
defined by: IA admin
edit access: IA admin
label: Access Restricted
definition: Collection contents are restricted access
accepted values:
true
usage notes: This tag is only used on items of mediatype collection (it will have no affect on items of any other type). This tag should only be assigned by internal IA admins.
example:
true
access-restricted-item#
required: No
repeatable: No
label: Access Restricted Item
definition: Identifies item that is access-restricted
accepted values:
true
usage notes: Only used on items, not collections. Automatically added to items in an access-restricted collection at the end of any task.
example:
true
defined by: IA admin
edit access: IA admin
internal use only: Yes
adaptive_ocr#
required: No
repeatable: No
label: Adaptive OCR
definition: Allows deriver to skip a page that would otherwise disrupt OCR
accepted values:
true
defined by: uploader
edit access: uploader
internal use only: No
addeddate#
required: Yes
repeatable: No
internal use only: No
defined by: IA software
edit access: not editable
label: Date Added to Public Search
definition: 2019-12 and later dates: represents time item was added to public search engine. Earlier dates: Date and time in UTC that the item was created archive.org
accepted values:
YYYY-MM-DD HH:MM:SS
,YYYY-MM-DD
usage notes: Beginning in December 2019 when item was first added to public search engine. It is added during the first task where the item does not have noindex present in meta.xml. The field is not changed or removed if the item is subsequently removed from public search. Prior to December 2019, Addeddate was automatically set when the item directory is been created in our file system. In many cases, the addeddate will be very similar to the publicdate. However, in some cases we create an item directory with metadata but no media files prior to the media being scanned. The addeddate reflects when the item was created, regardless of when the media was added to the item. When the media is added at a later date and a derive.php task is run, the publicdate will be added to the item.
example:
2017-03-28 22:05:46
admin-collection#
required: No
repeatable: No
internal use only: Yes
edit access: IA admin
label: Admin Collection
definition: Collection will generally be suppressed from public display, e.g. in facets, membership lists on Collection/Details pages, etc.
accepted values:
true
usage notes: Only used by internal IA admins
example:
true
defined by: IA admin
aspect_ratio#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Aspect Ratio
definition: Ratio of the pixel width and height of a video stream
accepted values:
#:#
usage notes: Standard values for this field are 4:3 and 16:9, but other values are possible.
example:
4:3
audio_codec#
required: No
repeatable: No
internal use only: No
defined by: IA software
edit access: IA admin
label: Audio Codec
definition: Program used to decode audio stream
accepted values:
String
usage notes: Primarily used for TV Archive items.
example:
ac3
audio_sample_rate#
required: No
repeatable: No
internal use only: No
defined by: IA software
edit access: IA admin
label: Audio Sample Rate
definition: Samples per second
accepted values:
Whole number
usage notes: Primarily used for TV Archive items.
example:
48000
betterpdf#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Better PDF
definition: Indicates that the derive module should create a higher quality PDF derivative (distinguishes text from background better).
accepted values:
true
usage notes: This field is either set to the value true, or is not included in meta.xml. If this field is included after the initial derive is run, user should also run a derive task to create the better quality PDF.
example:
true
bookreader-defaults#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Bookreader defaults
definition: Indicates whether the bookreader should display one or two pages by default
accepted values:
mode/1up
,mode/2up
,mode/thumb
usage notes: The bookreader defaults to showing books in 2up mode, so this field is generally only used to indicate that an item should be displayed in 1up mode (showing only one page at a time in the bookreader).
example:
mode/1up
boxid#
required: No
repeatable: Yes
definition: Location of physical item in the Physical Archive
accepted values:
IA######
usage notes: Boxids always start with the letters IA followed by numbers. The numbers represent the container, pallet and box that the physical item is stored in. When there are multiple boxid fields in meta.xml, the first boxid listed represents the physical item that was digitized. Subsequent boxid fields represent the location of duplicate physical items.
example:
IA158001
edit access: IA admin
defined by: IA admin
label: Box ID
internal use only: Yes
bwocr#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Black and White OCR
definition: Allows deriver to OCR specific pages as B&W if color is causing failure.
accepted values:
page number or range, e.g. 001
call_number#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Call Number
definition: Contributing library’s local call number
accepted values:
string
example:
6675707
NC 285.1 P9287m
camera#
required: No
repeatable: No
internal use only: No
defined by: user admin
edit access: user admin
label: Camera
definition: Camera model used during digitization process
accepted values:
String
example:
Canon 5D
ccnum#
required: No
repeatable: No
internal use only: No
edit access: uploader
label: Closed Captioning Number
definition: Indicates which closed captioning file should be used for display and search
accepted values:
cc#
,asr
,ocr
,#
usage notes: Primarily used for TV Archive items. Closed captioning files are stored as [identifier].cc#.txt in the item. This tag indicates which cc# file to display in item and use for search indexing.
example:
cc5
defined by: uploader
closed_captioning#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Closed Captioning
definition: Indicates whether item contains closed captioning files
accepted values:
yes
,no
usage notes: Field is generally only present when the video has closed captioning. When captioning is not present, the field may have “no” as the value, or just not be included in meta.xml
example:
yes
no
collection#
required: No
repeatable: Yes
internal use only: No
defined by: user admin
edit access: user admin
label: Collections
definition: Indicates to the website what collection(s) this item belongs to.
accepted values:
Must be a valid identifier
example:
prelinger
usage notes: Required for all items except “fav-username” collections. Always list the item’s primary collection first in meta.xml; this is the collection the item “belongs” to. The primary collection often represents the entity that contributed or created the content. Uploaders can only choose from collections that they have privileges for. General uploaders with no special privs can only upload to selected “Community” collections or the test_collection. Items in the test_collection are removed from the site after 30 days.
color#
required: No
repeatable: No
label: Color
definition: Indicates whether media is in color or black and white
accepted values:
String
usage notes: Most used values are: color, B&W (black and white) Mostly used for video items, indicates whether video is color or black and white. Can be used to indicate different kinds of color (e.g. Kodachrome).
example:
color
defined by: uploader
edit access: uploader
internal use only: No
condition#
required: No
repeatable: No
label: Condition
definition: condition of media
accepted values:
Mint
,Near Mint
,Very Good
,Good
,Fair
,Worn
,Poor
,Fragile
,Incomplete
usage notes: Defines the condition of the media in an item. In 78s and LPs this indicates the condition of the disc or media file. For sets with multiple discs, use the condition of the lowest grade disc in the set.
example:
Good
defined by: uploader
edit access: uploader
internal use only: No
condition-visual#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Visual Condition
definition: condition of the artwork or printed materials that accompany a media item
accepted values:
Mint
,Near Mint
,Very Good
,Good
,Fair
,Worn
,Poor
,Fragile
,Incomplete
,None
,Unknown
example:
Good
usage notes: Defines the condition of the artwork or printed materials that accompany the media in an item. In LPs this is used for album covers and sleeves. “Incomplete” should be used when we know that artwork/printed materials are missing. “None” should be used when the item has no artwork/printed materials and we know it is not supposed to have any. “Unknown” should be used when artwork/printed material MAY be missing, but we cannot verify.
contributor#
required: No
repeatable: No
label: Contributor
definition: The person or organization that provided the physical or digital media.
accepted values:
String
usage notes: For physical items that have been digitized, contributor represents the library or other organization that owns the physical item. For born-digital media, contributor often represents the organization responsible for the distribution of the content (e.g. a radio station or television station).
example:
Robarts - University of Toronto
defined by: uploader
edit access: uploader
internal use only: No
coverage#
required: No
repeatable: Yes
internal use only: No
defined by: uploader
edit access: uploader
label: Coverage
definition: Geographic or subject area covered by item
accepted values:
String
usage notes: The preferred use of this field is to signify a geographical location that relates to the item. For example, in the TV and radio collections, we use the ISO 3166 location code for the country and state/territory of the station being recorded.
example:
GB-LND
creator#
required: No
repeatable: Yes
definition: The individual(s) or organization that created the media content.
usage notes: For items provided by libraries, the creator is often listed using the Library of Congress Name Authority Headings, http://authorities.loc.gov/ For items from other sources, the creator is often listed as first name and surname. When an item was created by an organization, such as a government agency or a production company, use the full name of the organization. This field represents the entity who created the media, not the person who uploaded the media to archive.org (though these may be the same person). All alphabets supported.
example:
Austen, Jane, 1775-1817
Ralph Burns
edit access: uploader
defined by: uploader
label: Creator
internal use only: No
accepted values:
String
creator-alt-script#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Creator Alternate Script
curation#
required: No
repeatable: No
internal use only: Yes
defined by: IA admin
edit access: IA admin
label: Curation
definition: Curation state and notes
accepted values:
String
usage notes: Curation is a compound field with “sub-fields”: curator, date, state, and comment. - Curator is the email address of the person who added the curation tag. - Date is the UTC time and date the curation tag was added, in YYYYMMDDHHMMSS format. - State can be: dark, approved, freeze, un-dark or blank - Comment can be a code used by the scanning center team to indicate issues found during QA, or a text string with some other curation comment (e.g. information about why an item was frozen or made dark). Items uploaded into open collections are generally checked by malware detection software, and the curation field will contain the results of that check.
example:
[curator]lenscriv@archive.org[/curator][date]20160504125613[/date][state]approved[/state][comment]199[/comment]
[curator]malware@archive.org[/curator][date]20140321085621[/date][comment]checked for malware[/comment]
date#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Publication Date
definition: Date of publication
accepted values:
String
usage notes: We encourage people to use YYYY, YYYY-MM, or YYYY-MM-DD for this field, but sometimes exact dates are not possible to determine. Other common usages: [YYYY] (brackets) when a date is not certain; c.a. YYYY (c.a.) when a date is approximate; and [n.d.] when a date is unknown (you may also leave the field blank in this case). If an item has a date range, such as YYYY-YYYY, we currently index only the first date in the range. Books, movies, and CDs often only have YYYY for a publication date. Magazines often have YYYY-MM for a publication date. Concerts and articles often have YYYY-MM-DD publication dates. Use the most specific verifiable date you have access to. When the item is a digitial representation of a physical piece of media (e.g. a book, a 78rpm disc, etc.) the publication date should represent the date that the specific physical item was published. A book may have been written in 1850, and then an edition was republished in 1885. If the digitized version is the edition republished in 1885, use 1885 as the publication date (not 1850).
example:
1965
2013-05-25
[n.d.]
description#
required: Recommended
repeatable: Yes
label: Item Description
definition: Describes the media stored in the item.
accepted values:
String, can contain links, formatting and images in html/css. Currently, with Collections, it can also contain raw Javascript, but we plan to remove this soon.
usage notes: May be about the media content (e.g. a description of the book’s plot), the physical item it represents (e.g. missing or damaged pages in the physical book that was digitized), the creator of the media (e.g. author biographical info that relates to the book), or any other information that may help a user understand the item or its context. All alphabets are supported.
example:
Cinemascope homage to the city of San Francisco made by amateur filmmaker and inventor Tullio Pellegrini.
internal use only: No
defined by: uploader
edit access: uploader
external-identifier#
required: No
repeatable: Yes
internal use only: No
accepted values:
String
definition: URLs or identifiers to outside resources that represent the media
usage notes: External-identifier includes Uniform Resource Names (URNs) for external resources about the media in the item. The field is usually in the form of urn:namespace:identifier.
example:
urn:publisher_catalog_id:88697 03614 2
urn:pubcat:victor:18890-B
urn:spotify:album:3jmETApVCjXb3hWTR1IEdH
urn:asin:0451531396
acs:epub:urn:uuid:d935586b-72a7-4720-bbb9-72fe75eae0e1
urn:acs6:blackreconstruc00dubo:epub:38413c16-074b-4fb6-a4dc-25e93e199d5f
urn:mb_artist_id:6de0f914-3e60-4418-be3b-42e0feb6eb4d
urn:X-pwacrawlid:AWP5
edit access: uploader
defined by: uploader
label: External Identifier
firstfiledate#
required: No
repeatable: No
definition: Creation date of the earliest file contained in the item
accepted values:
YYYYMMDDHHMMSS
usage notes: Primarily used for WARC items
example:
20211103001952
edit access: uploader
defined by: IA software
label: First File Date
internal use only: No
fixed-ppi#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Fixed PPI
definition: To change the ppi to a specific resolution. Usually lower especially when jp2.zip fails
accepted values:
Number
foldoutcount#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: Fold Out Count
definition: Number of fold outs captured by operator
accepted values:
Whole number
usage notes: Fold outs are photographed on machinery other than the Scribe. This field indicates how many foldouts were captured. The value may be 0 or higher.
example:
1
frames_per_second#
required: No
repeatable: No
definition: Frequency at which consecutive images are displayed
accepted values:
Number
usage notes: Primarily used for TV Archive items.
example:
29.97
edit access: uploader
defined by: IA software
label: Frames Per Second
internal use only: No
geo_restricted#
required: No
repeatable: No
internal use only: Yes
defined by: IA admin
edit access: IA admin
label: Geo Restricted
definition: Limits access based on ISO-2 Country Code
accepted values:
e.g US
identifier#
required: Yes
repeatable: No
internal use only: No
defined by: uploader
edit access: IA admin
label: Item Identifier
definition: Unique identifier for an item on the archive.org web site. Used in the URL for the item, ie archive.org/details/[identifier].
accepted values:
String, minimum length is 5 characters, maximum length is 100 characters, contains only Roman alphabet characters, numbers, periods (.), underscores ( _ ), or dashes ( - ), and first character must be alphanumeric.
,mediatype:account items begin with @ symbol.
usage notes: We encourage the use of human-readable identifiers, rather than opaque strings of numbers or letters. For most projects we try to keep identifiers below 80 characters in length for the sake of readability.
example:
SanFrancisco1955CinemascopeFilm
identifier-ark#
required: No
repeatable: No
label: ARK
definition: Archival Resource Key identifier
accepted values:
ark:/NAAN/Name
usage notes: ARKs are URLs designed to support long-term access to information objects. We store the ark:/NAAN/Name portion of the URL in meta.xml. This can be tacked on to any ARK resolver’s domain to resolve the ARK, i.e. http://n2t.net/. Read about ARKs: http://n2t.net/e/ark_ids.html ARK specification: http://n2t.net/e/arkspec.txt
example:
ark:/13960/t4rj5fk7h
defined by: uploader
edit access: uploader
internal use only: No
identifier-bib#
required: No
repeatable: Yes
internal use only: No
defined by: uploader
edit access: uploader
label: Local Identifier
definition: Additional local identifiers
accepted values:
string
usage notes: Fields for many identifiers exist in the schema, including isbn, issn, oclc, and call_number. The identifier-bib field is used for additional local identifiers that don’t have a place elsewhere in metadata. These identifiers are unique to the institution providing the item.
example:
GLAD-84064318
imagecount#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA software
label: Image Count
definition: Imagecount gives an indication of the size of the content of an item (outside of file size, which is represented in the size field). Originally used only for books, the field has been repurposed over time to provide similar information for other mediatypes.
accepted values:
Positive whole number
usage notes: Texts: represents number of page images in the item TV: represents number of seconds of video in the item Web: represents number of URIs captured in the WARCs in the item CD: number of images of physical item and accompanying materials
example:
230
isbn#
required: No
repeatable: Yes
definition: ISBN-10 or ISBN-13
example:
3540212507
031294716X
accepted values:
String of 10 or 13 digits.
,Final digit can be [0-9] or 'X'
usage notes: https://www.iso.org/standard/65483.html https://www.isbn.org/faqs_general_questions#isbn_faq5
label: ISBN
defined by: uploader
edit access: uploader
internal use only: No
issn#
required: No
repeatable: Yes
internal use only: No
defined by: uploader
edit access: uploader
label: ISSN
definition: ISSN
accepted values:
String of 2 groups of four digits separated by a hyphen. Final digit can be [0-9] of 'X'
usage notes: ISSNs are identifying numbers for serials. See https://www.issn.org/understanding-the-issn/what-is-an-issn/ for clarification.
example:
2528-7788
1943-345X
language#
required: No
repeatable: Yes
internal use only: No
accepted values:
String
definition: The language the media is written or recorded in.
usage notes: For items provided by libraries, the language is often provided as a 3 letter MARC language code (e.g. eng), https://www.loc.gov/marc/languages/ For other items, the language is often written out as the full name (e.g. English). Not all items have a language associated with them (e.g. instrumental music), but when there is written or spoken language we are able to do some sorts of processing better when we know the language. To skip OCR on an item, set the value to None When an item contains no OCRable content, you will sometimes see the language set to zxx. Language is particularly important for text items so that we can do the best job with optical character recognition processing.
example:
eng
Italian
None
edit access: uploader
defined by: uploader
label: Language
lastfiledate#
required: No
repeatable: No
internal use only: No
edit access: uploader
label: Last File Date
definition: Date of creation of oldest file in the item
accepted values:
YYYYMMDDHHMMSS
usage notes: Primarily used for WARC items
example:
20211103003910
defined by: IA software
lccn#
required: No
repeatable: Yes
label: LCCN
definition: Library of Congress Call Number
accepted values:
Whole number
usage notes: https://www.loc.gov/marc/lccn_structure.html
example:
2004045278
internal use only: No
defined by: uploader
edit access: uploader
licenseurl#
required: No
repeatable: No
internal use only: No
edit access: uploader
label: License URL
definition: URL of the selected license
accepted values:
URL
usage notes: This link should point to a recognized license, like Creative Commons or GNU. For other types of rights statements, use the rights field.
example:
http://creativecommons.org/licenses/by-nd/3.0/
defined by: uploader
mediatype#
required: Yes
repeatable: No
definition: Mediatype tells us about the main content of the item. It is used to determine how the item is displayed on the web site and may trigger special processing depending on the types of files contained in the item.
accepted values:
texts
,etree
,audio
,movies
,software
,image
,data
,web
,collection
,account
usage notes: texts: books, articles, newspapers, magazines, any documents with content that contains text etree: live music concerts, items should only be uploaded for artists with collections in the etree “Live Music Archive” community audio: any item where the main media content is audio files, like FLAC, mp3, WAV, etc. movies: any item where the main media content is video files, like mpeg, mov, avi, etc. software: any item where the main media content is software intended to be run on a computer or related device such as gaming devices, phones, etc. image: any item where the main media content is image files (but is not a book or other text item), like jpeg, gif, tiff, etc. data: any item where the main content is not media or web pages, such as data sets web: any item where the main content is copies of web pages, usually stored in WARC or ARC format collection: designates the item as a collection that can “contain” other items account: designates the item as being a user account page, can only be set by internal archive systems
label: Type of Media
example:
movies
defined by: uploader
edit access: IA admin
internal use only: No
neverindex#
required: No
repeatable: No
internal use only: Yes
defined by: IA admin
edit access: IA admin
label: Never Index
definition: Prevents RePublisher from removing noindex at the end of the texts digitization process.
accepted values:
true
usage notes: Only used on internally digitized texts items. Normally when a text finishes the RePublisher process, the noindex tag is removed and the book is added to the public search engine. The neverindex tag prevents the removal of noindex, so books with nevrindex set to true should not end up in the public search engine.
example:
true
next_item#
required: No
repeatable: No
definition: IA identifier of next item from a recorded feed
accepted values:
identifier
usage notes: Primarily used for TV Archive items.
example:
BBCNEWS_20121204_090000_BBC_News
edit access: IA admin
defined by: IA software
label: Next Item
internal use only: Yes
no_ol_import#
required: No
repeatable: No
internal use only: Yes
defined by: IA admin
edit access: IA admin
label: No OL Import
definition: Keeps books out of open library
accepted values:
true
noindex#
required: No
repeatable: No
label: No Index
definition: Prevents item from being indexed in public archive.org search engine
accepted values:
true
usage notes: While the accepted practice is to have a value of “true” for this tag, the mere presence of the tag in meta.xml will actually cause the same effect regardless of the value used (including empty). In addition to not being included in the public archive.org search engine, the noindex tag will also cause the item to not be listed in the sitemap.
example:
true
defined by: uploader
edit access: uploader
internal use only: Yes
notes#
required: No
repeatable: Yes
internal use only: No
defined by: uploader
edit access: uploader
label: Notes
definition: additional notes about the item
accepted values:
String
example: []
usage notes: Use the description field to describe the media stored in an item. The notes field is for additional information like condition of othe physical item, technical notes about digitization, or similar.
oclc-id#
required: No
repeatable: Yes
internal use only: No
defined by: uploader
edit access: uploader
label: OCLC ID
definition: Identifier of same edition in OCLC records
accepted values:
String
example:
37432884
ocr#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: OCR Software
definition: Software package and version used for optical character recognition
accepted values:
String
usage notes: Set during derivation process.
example:
ABBYY FineReader 8.0
openlibrary#
required: Deprecated
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Open Library Identifier
definition: Deprecated. Open Library edition identifier
accepted values:
OL#M
usage notes: This field is deprecated. Please use openlibrary_edition.
example:
OL2769393M
openlibrary_edition#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Open Library edition identifier
definition: Open Library edition identifier
accepted values:
OL#M
usage notes: Correlates to the edition page on openlibrary.org. The OL edition page URL is https://openlibrary.org/books/[openlibrary_edition]
example:
OL2769393M
openlibrary_subject#
required: No
repeatable: Yes
internal use only: No
defined by: uploader
edit access: uploader
label: Open Library subject
definition: Open Library subject
accepted values:
string
usage notes: This field is currently used to supply books for carousels on the openlibrary.org home page. At some point it will also be used to import subjects from the openlibrary_work associated with the item.
example:
openlibrary_staff_picks
openlibrary_work#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Open Library work identifier
definition: Open Library work identifier
accepted values:
OL#W
usage notes: Correlates to the work page on openlibrary.org. The OL work page URL is https://openlibrary.org/works/[openlibrary_edition]
example:
OL675783W
operator#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: Operator
definition: Email of the person who scanned/captured the media in the item
accepted values:
String
usage notes: usually email address. In texts this represents the person who operated the Scribe or other scanning equipment. In web items this represents the engineer responsible for the crawl.
example:
associate-stephanie-kinsey@archive.org
page-progression#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Page Progression
definition: Determines direction pages will be “turned” in a book
accepted values:
lr
,rl
usage notes: lr = left to right rl = right to left
example:
rl
lr
possible-copyright-status#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Possible Copyright Status
definition: Information relevant to copyright status
accepted values:
string
usage notes: Do not use this field for CC license information (see licenseurl).
example:
The Centers for Medicare & Medicaid Services Library is unaware of any copyright restrictions for this item.
ppi#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: PPI
definition: Pixels per inch
accepted values:
Positive whole number
usage notes: Indicates pixels per inch for an image. The most common use case is Internet Archive digitization centers. This number is set during the book scanning process.
example:
300
previous_item#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: Previous Item
definition: IA identifier of previous item from a recorded feed
accepted values:
identifier
usage notes: Primarily used for TV Archive items.
example:
BBCNEWS_20121204_060000_Breakfast
public-format#
required: No
repeatable: Yes
definition: Collection file formats that are available to users in an Access Restricted collection
accepted values:
String
internal use only: Yes
usage notes: This tag only affects items of mediatype collection and must be used in conjunction with the access-restricted tag. This tag should only be assigned by internal IA admins.
label: Public Formats
defined by: IA admin
example:
Metadata
edit access: IA admin
publicdate#
required: Yes
repeatable: No
internal use only: Yes
defined by: IA software
edit access: not editable
label: Date Archived
definition: The date and time in UTC that the item was created on archive.org.
accepted values:
YYYY-MM-DD HH:MM:SS
,YYYY-MM-DD
usage notes: Publicdate is automatically set when the first catalog task finishes on that item’s directory.
example:
2011-12-25 19:01:43
publisher#
required: No
repeatable: No
definition: Publisher of the media
accepted values:
String
usage notes: - Books use publisher - Movies often use production company - Music often uses record label
example:
New York : R.R. Bowker Co.
edit access: uploader
defined by: uploader
label: Publisher
internal use only: No
repub_state#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: Repub State
definition: Indicates the current state of a scanned book.
accepted values:
Whole number
example:
19
republisher#
required: Deprecated
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: Republisher
definition: Deprecated. Email of the person who completed republishing the item
accepted values:
email address
usage notes: This field is deprecated.
example:
associate-kiana-fekette@archive.org
republisher_date#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: Republisher Date
definition: Date and time in UTC that the item was created archive.org
accepted values:
YYYYMMDDHHMMSS
usage notes: Set by Scribe3 software.
example:
20170801165730
republisher_operator#
required: No
repeatable: No
internal use only: Yes
defined by: IA software
edit access: IA admin
label: Republisher Operator
definition: Email of the person who completed republishing the item
accepted values:
email address
usage notes: Set by Scribe3 software.
example:
associate-kiana-fekette@archive.org
republisher_time#
required: No
repeatable: No
label: Republisher Time
definition: Number of seconds required to republish text
accepted values:
whole number
usage notes: Set by Scribe3 software.
example:
504
defined by: IA software
edit access: IA software
internal use only: Yes
rights#
required: No
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Rights
definition: Rights statement
accepted values:
String
usage notes: Please see licenseurl for URL-based rights designations, like Creative Commons. For other rights information or statements, use the rights field.
example:
Permission is granted under the Wikimedia Foundation's
These National Treasury publications may not be reproduced wholly or in part without the express authorisation of the National Treasury in writing unless used for non-profit purposes.
runtime#
required: No
repeatable: Yes
internal use only: No
definition: Length of an audio or video item
usage notes: Uploader can set this field, but most often we have determined and set this value during the derive process.
label: Run Time
accepted values:
HH:MM:SS
,H:MM:SS
,MM:SS
,M:SS
,0:SS
edit access: uploader
defined by: IA software
example:
00:15:00
2:12
0:23
scandate#
required: No
repeatable: No
definition: The date and time in UTC that the media was captured.
accepted values:
String
internal use only: No
usage notes: When an physical item is scanned/digitized, scandate represents the date/time that the digitization occurred. For web items, scandate represents the date/time the first WARC file in the item was created. For TV and radio items, scandate represents the begining time of the recording. Formats: YYYYMMDDHHMMSS YYYYMMDD YYYY YYYY-MM-DD HH:MM:SS
label: Scan Date
edit access: uploader
defined by: uploader
example:
20170329201345
scanfee#
required: No
repeatable: No
definition: Scanning fee used during billing process
accepted values:
string
internal use only: Yes
usage notes: Set by software based on parameters for each scanning partner
label: Scan Fee
edit access: IA admin
defined by: IA software
example:
100
300;10;200
0;1.45;0
scanner#
required: No
repeatable: No
definition: Machinery used to digitize or collect the media
label: Scanner
accepted values:
String
example:
scribe2.nj.archive.org
selenium-101.us.archive.org
Lasergraphics Scanstation
ArchiveCD Version 2.1.15
Internet Archive HTML5 Uploader 1.6.3
usage notes: Primarily an internally used field. For digitized texts this represents the individual digitization station (e.g. Scribe 2 in the New Jersey center). For web items this represents the crawl machine used to gather the data. For films this represents the film scanner. For CDs this represents the version of the scanning software used for that CD. For end-user contriuted items, this represents the software used to upload the item.
internal use only: No
edit access: uploader
defined by: uploader
scanningcenter#
required: No
repeatable: No
definition: The location where a digital copy of the media item was created
accepted values:
String
usage notes: Generally used in conjunction with our scanning services, this tag gives the location where an item was digitized, scanned or captured.
example:
boston
edit access: IA admin
defined by: IA software
label: Scanning Center
internal use only: Yes
size#
required: No
repeatable: Yes
definition: Size of physical item digitized
usage notes: This field is used for physical items that have been digitized. It denotes the size of the physical item. It is widely used to indicate the size of the record in our digitization efforts, e.g. 10 for 78s or 12 for vinyl. If no unit is measurement is specified, assume inches.
label: Size
accepted values:
Number
example:
10.0
defined by: uploader
edit access: uploader
internal use only: No
sort-by#
required: No
repeatable: No
internal use only: No
definition: Allows default collection sort to be changed from the standard Views order
usage notes: This tag only works on items that are collection mediatype, and can only be set by people with privileges for that collection. Sorting by -downloads is allowed, but would currently be redundant, as that is already the default sort for all collections without this tag.
label: Default Collection Sort
accepted values:
addeddate
,-addeddate
,creatorSorter
,-creatorSorter
,date
,-date
,downloads
,-downloads
,publicdate
,-publicdate
,reviewdate
,-reviewdate
,titleSorter
,-titleSorter
edit access: user admin
defined by: user admin
example:
-date
sound#
required: No
repeatable: No
internal use only: No
definition: Indicates whether media has sound or is silent
usage notes: Most used values are: sound, silent Mostly used for video items, this field indicates whether the media has related sound or is silent.
label: Sound
accepted values:
String
edit access: uploader
defined by: uploader
example:
sound
silent
source#
required: No
repeatable: No
internal use only: No
definition: Source of media
usage notes: Used to signify where a piece of media originated, or what the physical media was prior to digitization. - Focused crawl items list the site being crawled in this field. - Texts digitization centers use the field to denote folios. - TV uses the field to indicate the signal source. - Internal audio digitization projects use this field to indicate the format of the original media (CD, LP, 78, etc.). - External users often use this field to list a URL where the media content originated. - Etree users use it to record the “path” for recording a live concert.
label: Source
accepted values:
String
edit access: uploader
defined by: uploader
example:
folio
Comcast Cable
CD
DPA 4021 > SX-M2 > SD 744T @ 44.1 kHZ/16 bit
source_pixel_height#
required: No
repeatable: No
internal use only: Yes
definition: Pixel height of original video stream
usage notes: Primarily used for TV Archive items.
label: Source Pixel Height
accepted values:
Whole number
edit access: IA admin
defined by: IA software
example:
480
source_pixel_width#
definition: Pixel width of original video stream
usage notes: Primarily used for TV Archive items.
required: No
label: Source Pixel Width
repeatable: No
accepted values:
Whole number
example:
704
internal use only: Yes
defined by: IA software
edit access: IA admin
sponsor#
definition: The person or organization that funded the digitization or collection of this media.
usage notes: For physical items (books, film, 78rpm, etc.), this represents the entity that funded the digitization/scanning work. For born-digital items (TV, Radio, Web, etc.) this represents the entity that funded the collection of the items.
required: No
label: Sponsor
repeatable: No
accepted values:
String
example:
Kahle-Austin Foundation
internal use only: No
defined by: uploader
edit access: uploader
sponsordate#
definition: Billing date for scanned materials
usage notes: Related to digitization work. Usually a date string “YYYYMMDD”, but can contain notes, such as: “not to be invoiced-past billing period” “Grant ended, item not yet invoiced” “sent20111010”
required: No
label: Sponsor Date
repeatable: No
accepted values:
String
example:
20100531
internal use only: Yes
defined by: IA admin
edit access: IA admin
start_localtime#
definition: Start time of program in broadcast time zone
usage notes: Primarily used for TV Archive items.
required: No
label: Local Start Time
repeatable: No
accepted values:
YYYY-MM-DD HH:MM:SS
example:
2010-03-26 18:00:00
internal use only: Yes
defined by: IA software
edit access: IA admin
start_time#
internal use only: Yes
usage notes: Primarily used for TV Archive items.
definition: Start time of program in UTC
required: No
label: UTC Start Time
repeatable: No
accepted values:
YYYY-MM-DD HH:MM:SS
edit access: IA admin
defined by: IA software
example:
2010-03-26 15:00:00
stop_time#
repeatable: No
required: No
accepted values:
YYYY-MM-DD HH:MM:SS
definition: Stop time of program in UTC
internal use only: Yes
usage notes: Primarily used for TV Archive items.
label: UTC Stop Time
edit access: IA admin
defined by: IA software
example:
2010-03-26 16:00:00
subject#
repeatable: Yes
required: No
accepted values:
String
definition: Subjects and/or topics covered by the media content
example:
France
usage notes: Books and other media objects from libraries often use Library of Congress Subject Headings, http://id.loc.gov/authorities/subjects.html. Some collections may use their own controlled vocabulary for setting subjects. Many other items use the subject field as more casual “tags.” All alphabets are supported.
label: Subject/Keyword
defined by: uploader
edit access: uploader
internal use only: No
summary#
internal use only: No
usage notes: This tag only works on items that are collection mediatype, and can only be set by people with privileges for that collection. Normally collection pages only show the first 2 lines of the collection description field on the Collection tab. Content entered into the summary tag for a collection will show at the top of the Collection tab in place of those 2 lines, can include HTML, and be any length (though we recommend keeping it as brief as possible).
definition: A summary section that appears on collection pages above the description, entire value appears at the top of the collection tab
required: No
label: Collection summary
repeatable: No
accepted values:
String, can contain links, formatting and images in html/css. Currently, with Collections, it can also contain raw Javascript, but we plan to remove this soon.
edit access: user admin
defined by: user admin
example:
The Universal School Library (USL), is a growing collection of digitized books within the Internet Archive's larger holdings, made available through controlled digital lending, and curated by a national advisory group of school librarians, librarian educators and researchers.
title#
definition: Title of media
required: Recommended
repeatable: No
accepted values:
String, plain text; no HTML or HTML entities (they'll be displayed in raw form).
usage notes: All alphabets are supported
example:
San Francisco (1955 Cinemascope film)
edit access: uploader
defined by: uploader
label: Title
internal use only: No
title_message#
required: No
repeatable: No
accepted values:
text
definition: Adds text to the item header <title>
edit access: IA admin
defined by: IA admin
label: Title Message
internal use only: Yes
title-alt-script#
internal use only: No
required: No
label: Title Alternate Script
repeatable: No
accepted values:
text
edit access: uploader
defined by: uploader
tuner#
internal use only: Yes
usage notes: Primarily used for TV Archive items. Maps the program number as used in H.222 Program Association Tables and Program Mapping Tables to a channel number that can be entered via digits on a receiver’s remote control.
definition: Virtual Channel the video was recorded from
required: No
label: Skip OCR
repeatable: No
accepted values:
String
edit access: IA admin
defined by: IA software
example:
Virtual Ch. 24
updated#
internal use only: Yes
usage notes: Timestamp is typically when the last task ran on the item, but metadata updates can also be triggered manually.
definition: Timestamp in the metadata table for the last time the item’s row in that table was written
required: No
label: Updated
repeatable: Yes
accepted values:
YYYY-MM-DD
edit access: not editable
defined by: IA software
example:
2014-12-05
updatedate#
internal use only: Yes
usage notes: Any time an item is changed via the editxml page by the updater (see <updater> field), a corresponding <updatedate> field is added to the meta.xml. Updatedate fields are added to meta.xml in the order changes have been made, so the oldest dates are listed first.
definition: Date the item was updated by updater
required: No
label: Update Date
repeatable: Yes
accepted values:
YYYY-MM-DD HH:MM:SS
edit access: not editable
defined by: IA software
example:
2009-03-02 21:48:28
updater#
internal use only: Yes
usage notes: After initial upload, when changes are made to the content of an item the account that made changes is included in the meta.xml in an <updater> field. Updater fields are added to meta.xml in the order changes have been made, so the first listed updater belongs to the oldest modification.
definition: Screen name of the account that updated the item
required: No
label: Updater
repeatable: Yes
accepted values:
String
edit access: not editable
defined by: IA software
example:
tracey pooh
uploader#
repeatable: No
required: Yes
accepted values:
Email address
definition: Email address of the account that uploaded the item to archive.org.
internal use only: Yes
label: Item Uploader
defined by: IA software
example:
footage@panix.com
edit access: IA admin
usage notes: The uploader field determines which account has full access to modify/edit/delete metadata and files from the item without having any special privileges granted. Any other account that wants to modify this item must have some level of administrative privilege granted by Internet Archive.
utc_offset#
internal use only: Yes
usage notes: Primarily used for TV Archive items.
definition: Offset between local time and UTC
required: No
label: UTC Offset
repeatable: No
accepted values:
Whole number
edit access: IA admin
defined by: IA software
example:
300
-400
video_codec#
internal use only: Yes
usage notes: Primarily used for TV Archive items.
definition: Program used to decode video stream
required: No
label: Video Codec
repeatable: No
accepted values:
String
edit access: IA admin
defined by: IA software
example:
mpeg2video
viruscheck#
repeatable: No
required: No
accepted values:
true
definition: Causes virus check task to run on any item added to the collection
internal use only: Yes
usage notes: This tag only functions on items of mediatype collection. The tag is either present with a value of “true” or it should not be present in the item metadata at all. Currently all items uploaded into the open community collections have the virus check task run on them, without needing this tag. Any other collection that needs virus checking should have this tag present in order to trigger the virus check task to run on items uploaded into the collection.
label: Virus Check
edit access: IA admin
defined by: IA software
example:
true
volume#
internal use only: No
usage notes: This field is not overwritten by MARC
definition: Volume number or name
required: No
label: Volume
repeatable: No
accepted values:
string
edit access: uploader
defined by: uploader
example:
15
year#
required: Deprecated
repeatable: No
internal use only: No
defined by: uploader
edit access: uploader
label: Year of Publication
definition: Deprecated, use date field
accepted values:
YYYY
usage notes: Deprecated, use date field
example:
1996
File Metadata Schema#
Below are _files.xml fields that have special meaning on archive.org.
album#
required: no
repeatable: no
definition: uploader
accepted values:
string
usage notes: Name of album for audio items
label: Album Name
artist#
usage notes: Similar to “creator”. This is a common tag used in audio files.
required: no
label: Media Artist
repeatable: no
atime#
required: no
repeatable: no
autoplay#
required: no
repeatable: no
bitrate#
required: no
label: Bit Rate
repeatable: no
btih#
definition: system
required: no
label: BitTorrent Info Hash
repeatable: no
accepted values:
string
collection-catalog-number#
required: no
repeatable: no
comment#
required: no
repeatable: no
crc32#
usage notes: Error-detecting code used to verify contents of file.
definition: system
required: yes
label: Cyclic Redundancy Check
repeatable: no
accepted values:
8-length hex digest
example:
0ed6ddef
creator#
required: no
label: Media Creator
repeatable: no
example:
Grateful Dead
ctime#
required: no
repeatable: no
external-identifier#
required: no
label: External Identifier
repeatable: no
external-identifier-match-date#
definition: uploader
required: no
repeatable: yes
example:
youtube:2018-07-19T04:36:11Z
format#
usage notes: Indicates the type (format) of file. See tab “File Formats” for examples
definition: system
required: yes
label: File Format
repeatable: no
accepted values:
string
example:
Thumbnail
genre#
required: no
label: Music Genre
repeatable: no
height#
usage notes: Image height (in pixels)
definition: uploader or system
required: no
label: Image Height
repeatable: no
accepted values:
integer
example:
600
length#
definition: uploader or system
required: no
label: Run Length
repeatable: no
usage notes: Run length (in seconds).
example:
274.97
04:35
matrix_number#
required: no
repeatable: no
md5#
required: yes
label: Message Digest 5 checksum
repeatable: no
accepted values:
32-length hex digest
definition: system
example:
5376a4d222f6b2938f79a5843224cd42
usage notes: Cryptographic hash used to verify contents of file.
mtime#
required: yes
label: modified time
repeatable: no
example:
1531829145
accepted values:
integer
definition: system
usage notes: Unix timestamp indicating when file was last modified.
name#
usage notes: Path to file name
required: yes
label: File Name
repeatable: no
accepted values:
string
definition: uploader
example:
WHPT_102_5_FM_20180717_110000.mp3
noti080130.thumbs/noti080130_001134.jpg
operatingsystem#
required: no
repeatable: no
original#
required: no
repeatable: no
label: Original File
accepted values:
string
definition: system
example:
WHPT_102_5_FM_20180717_110000.mp3
usage notes: For derivative files, this indicates the original file the derive was performed upon.
original-name#
required: no
repeatable: no
private#
required: no
repeatable: no
definition: system
label: Restricted Access
accepted values:
true
example:
true
usage notes: Indicates that access to this file is restricted to users with appropriate permissions
publisher#
required: no
repeatable: no
rotation#
required: no
repeatable: no
accepted values:
integer
usage notes: represents the rotation (in degrees) of the camera. Typical values are: 0, 90, 180, 270
definition: uploader
label: Camera Rotation
sha1#
required: yes
repeatable: no
definition: system
label: Secure Hash Algorithm 1
accepted values:
40-length hex digest
example:
eec164bd3fca541beb3bb092826e8b47a8c91385
usage notes: Cryptographic hash used to verify contents of file.
size#
required: yes
repeatable: no
definition: system
label: File Size
accepted values:
integer
example:
31985916
usage notes: File size in bytes
source#
required: yes
repeatable: no
definition: system
label: File Source
accepted values:
original
,derivative
,metadata
example:
original
usage notes: Indicates whether the file was uploaded by a user (original) or generated by the system (derivative or metadata)
title#
required: no
repeatable: no
accepted values:
string
usage notes: Song or track title in audio files.
definition: uploader
label: Track Title
track#
required: no
repeatable: no
definition: uploader
label: Track Number
accepted values:
integer or string
example:
1
usage notes: Track number of album. Usually an integer, but occasionally has values like “2/14” (track 2 of 14)
wb_filtered#
required: no
repeatable: no
width#
definition: uploader or system
required: no
repeatable: no
example:
800
accepted values:
integer
label: Image Width
usage notes: Image width (in pixels)