Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/fatcat-containers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: fatcat auth Containers API
version: 0.5.0
description: 'Fatcat is a scalable, versioned, API-oriented catalog of bibliographic
entities and file metadata.
<!-- STARTLONGDESCRIPTION -->
These API reference documents, along with client software libraries, are
generated automatically from an OpenAPI 2.0 ("Swagger") definition file.
## Introduction
A higher-level introduction to the API, as well as a description of the
fatcat data model, are available in ["The Fatcat Guide"](https://guide.fatcat.wiki/).
The guide also includes a [Cookbook](https://guide.fatcat.wiki/cookbook.html)
section demonstrating end-to-end tasks like creating entities as part of
editgroups, or safely merging duplicate entities.
### Expectations and Best Practices
A test/staging QA API instance of fatcat is available at
<https://api.qa.fatcat.wiki/v0>. The database backing this instance is
separate from the production interface, and is periodically rebuilt from
snapshots of the full production database, meaning that edits on the QA
server will *NOT* persist, and that semantics like the changelog index
monotonically increasing *MAY* be broken. Developers are expexcted to test
their scripts and tools against the QA instance before running against
production.
NOTE: as of Spring 2021, the QA server is temporarily unavailable.
Fatcat is made available as a gratis (no cost) and libre (freedom
preserving) service to the public, with limited funding and resources. We
welcome new and unforeseen uses and contributions, but may need to impose
restrictions (like rate-limits) to keep the service functional for other
users, and in extreme cases reserve the option to block accounts and IP
ranges if necessary to keep the service operational.
The Internet Archive owns and operates it''s own server equipment and data
centers, and operations are optimized for low-cost, not high-availability.
Users and partners should expect some downtime on the fatcat API, on the
order of hours a month.
Periodic metadata exports are available for batch processing, and database
snapshots can be used to create locally-hosted mirrors of the service for
more intensive and reliable querying.
### Other Nitty Gritties
Cross-origin requests are allowed for the API service, to enable third
parties to build in-browser applications.
A metadata search service is available at <https://search.fatcat.wiki>.
The API is currently the raw elasticsearch API, with only GET (read)
requests allowed. This public service is experimental and may be removed or
limited in the future.
## Authentication
The API allows basic read-only "GET" HTTP requests with no authentication.
Proposing changes to the metadata, or other mutating requests ("PUT",
"POST", "DELETE") all require authentication, and some operations require
additional account permissions.
End-user account creation and login happens through the web interface. From
a logged-in editor profile page, you can generate a API token. Tokens are
"macaroons", similar to JWT tokens, and are used for all API
authentication. The web interface includes macaroons in browser cookies and
passes them through to the API to authenticate editor actions.
<!-- ReDoc-Inject: <security-definitions> -->
<!-- ENDLONGDESCRIPTION -->
'
termsOfService: https://guide.fatcat.wiki/policies.html
contact:
name: Internet Archive Web Group
email: webservices@archive.org
url: https://fatcat.wiki
x-logo:
url: https://fatcat.wiki/static/paper_man_confused.gif
altText: Confused Papers Man (Logo)
backgroundColor: '#FFFFFF'
servers:
- url: https://api.fatcat.wiki/v0
tags:
- name: containers
x-displayName: Containers
description: '**Container** entities represent publication venues like journals, # TAGLINE
conference proceedings, book series, or blogs. They group publications # TAGLINE
("releases"). # TAGLINE
See the "Catalog Style Guide" section of the guide for details and # TAGLINE
semantics of what should be included in specific entity fields. # TAGLINE
Specifically, the # TAGLINE
[Container Entity Reference](https://guide.fatcat.wiki/entity_container.html). # TAGLINE
'
paths:
/editgroup/{editgroup_id}/container:
parameters:
- name: editgroup_id
in: path
required: true
schema:
type: string
post:
operationId: create_container
tags:
- containers
description: 'Create a single Container entity as part of an existing editgroup.
Editgroup must be mutable (aka, not accepted) and editor must have
permission (aka, have created the editgroup or have `admin` role).
'
security:
- Bearer: []
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
401:
description: Not Authorized
headers:
WWW_Authenticate:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
201:
description: Created Entity
content:
application/json:
schema:
$ref: '#/components/schemas/entity_edit'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/container_entity'
required: true
/editgroup/auto/container/batch:
post:
operationId: create_container_auto_batch
tags:
- containers
description: 'Create a set of Container entities as part of a new editgroup, and
accept that editgroup in the same atomic request.
This method is mostly useful for bulk import of new entities by
carefully written bots. This method is more efficient than creating an
editgroup, several entities, then accepting the editgroup, both in
terms of API requests required and database load. Requires `admin`
role.
'
security:
- Bearer: []
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
401:
description: Not Authorized
headers:
WWW_Authenticate:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
201:
description: Created Editgroup
content:
application/json:
schema:
$ref: '#/components/schemas/editgroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/container_auto_batch'
required: true
/container/{ident}:
parameters:
- name: ident
in: path
required: true
schema:
type: string
get:
operationId: get_container
tags:
- containers
description: 'Fetches a single container entity from the catalog.
'
parameters:
- name: expand
in: query
required: false
description: List of sub-entities to expand in response. For containers, none accepted (yet).
schema:
type: string
- name: hide
in: query
required: false
description: List of entity fields to elide in response. For containers, none accepted (yet).
schema:
type: string
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Found Entity
content:
application/json:
schema:
$ref: '#/components/schemas/container_entity'
/editgroup/{editgroup_id}/container/{ident}:
parameters:
- name: editgroup_id
in: path
required: true
schema:
type: string
- name: ident
in: path
required: true
schema:
type: string
put:
operationId: update_container
tags:
- containers
description: 'Updates an existing entity as part of a specific (existing) editgroup.
The editgroup must be open for updates (aka, not accepted/merged), and
the editor making the request must have permissions (aka, must have
created the editgroup or have `admin` role).
This method can also be used to update an existing entity edit as part
of an editgroup. For example, if an entity was created in this
editgroup, an editor could make changes to the new entity''s metadata
before merging.
'
security:
- Bearer: []
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
401:
description: Not Authorized
headers:
WWW_Authenticate:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Updated Entity
content:
application/json:
schema:
$ref: '#/components/schemas/entity_edit'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/container_entity'
required: true
delete:
operationId: delete_container
tags:
- containers
description: 'Creates a new "deletion" edit for a specific entity as part of an
existing editgroup.
This is not the method to use to remove an edit from an editgroup; for
that use `delete_container_edit`.
'
security:
- Bearer: []
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
401:
description: Not Authorized
headers:
WWW_Authenticate:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Deleted Entity
content:
application/json:
schema:
$ref: '#/components/schemas/entity_edit'
/container/rev/{rev_id}:
parameters:
- description: UUID (lower-case, dash-separated, hex-encoded 128-bit)
name: rev_id
in: path
required: true
schema:
type: string
maxLength: 36
minLength: 36
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
get:
operationId: get_container_revision
tags:
- containers
description: 'Fetches a specific entity revision. Note that the returned revision
will not be associated with any particular fatcat identifier (even if
one or more identifiers do currently point to this revision). The
revision may even be part of an un-merged editgroup.
Revisions are immutable and can not be deleted or updated.
'
parameters:
- name: expand
in: query
required: false
description: List of sub-entities to expand in response. See `get_container`.
schema:
type: string
- name: hide
in: query
required: false
description: List of entity fields to elide in response. See `get_container`.
schema:
type: string
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Found Entity Revision
content:
application/json:
schema:
$ref: '#/components/schemas/container_entity'
/container/{ident}/history:
parameters:
- name: ident
in: path
required: true
schema:
type: string
- name: limit
in: query
required: false
description: Maximum number of changelog entries to return
schema:
type: integer
format: int64
get:
tags:
- containers
description: 'Fetches the history of accepted edits (changelog entries) for a
specific entity fatcat identifier.
'
operationId: get_container_history
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Found Entity History
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/entity_history_entry'
/container/{ident}/redirects:
parameters:
- name: ident
in: path
required: true
schema:
type: string
get:
operationId: get_container_redirects
tags:
- containers
description: 'Returns the set of entity identifiers which currently redirect to this
identifier.
'
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Found Entity Redirects
content:
application/json:
schema:
type: array
items:
type: string
pattern: '[a-zA-Z2-7]{26}'
minLength: 26
maxLength: 26
description: base32-encoded unique identifier
/container/lookup:
get:
operationId: lookup_container
tags:
- containers
description: 'Looks for an active entity with the given external identifier. If any
such entity is found, returns a single complete entity. If multiple
entities have the same external identifier, this is considered a soft
catalog error, and the behavior of which entity is returned is
undefined.
One (and only one) external identifier should be specified per request.
'
parameters:
- name: issnl
in: query
required: false
description: Linking ISSN (ISSN-L); will be one of either ISSN-E or ISSN-P
schema:
type: string
maxLength: 9
minLength: 9
pattern: \d{4}-\d{3}[0-9X]
- name: issne
in: query
required: false
description: Electronic ISSN (ISSN-L)
schema:
type: string
maxLength: 9
minLength: 9
pattern: \d{4}-\d{3}[0-9X]
- name: issnp
in: query
required: false
description: Print ISSN (ISSN-P)
schema:
type: string
maxLength: 9
minLength: 9
pattern: \d{4}-\d{3}[0-9X]
- name: issn
in: query
required: false
description: Any of ISSN-L, ISSN-E, or ISSN-P
schema:
type: string
maxLength: 9
minLength: 9
pattern: \d{4}-\d{3}[0-9X]
- name: wikidata_qid
in: query
required: false
schema:
type: string
- name: expand
in: query
required: false
description: List of sub-entities to expand in response. See `get_container`.
schema:
type: string
- name: hide
in: query
required: false
description: List of entity fields to elide in response. See `get_container`.
schema:
type: string
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Found Entity
content:
application/json:
schema:
$ref: '#/components/schemas/container_entity'
/container/edit/{edit_id}:
get:
operationId: get_container_edit
tags:
- containers
description: 'Returns the entity edit object with the given identifier. This method
is expected to be used rarely.
'
parameters:
- description: UUID (lower-case, dash-separated, hex-encoded 128-bit)
name: edit_id
in: path
required: true
schema:
type: string
maxLength: 36
minLength: 36
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Found Edit
content:
application/json:
schema:
$ref: '#/components/schemas/entity_edit'
/editgroup/{editgroup_id}/container/edit/{edit_id}:
parameters:
- name: editgroup_id
in: path
required: true
schema:
type: string
- description: UUID (lower-case, dash-separated, hex-encoded 128-bit)
name: edit_id
in: path
required: true
schema:
type: string
maxLength: 36
minLength: 36
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
delete:
operationId: delete_container_edit
tags:
- containers
description: 'Removes a single edit from the specified editgroup. The editgroup must
be mutable (aka, not accepted/merged), and the editor making this
request must have permission (aka, have created the editgroup or hold
the `admin` role).
Not to be confused with the `delete_container` method, which *creates*
a new edit in the given editgroup.
'
security:
- Bearer: []
responses:
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
404:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
500:
description: Generic Error
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
401:
description: Not Authorized
headers:
WWW_Authenticate:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
403:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
200:
description: Deleted Edit
content:
application/json:
schema:
$ref: '#/components/schemas/success'
components:
schemas:
entity_history_entry:
type: object
required:
- edit
- editgroup
- changelog_entry
properties:
edit:
$ref: '#/components/schemas/entity_edit'
editgroup:
$ref: '#/components/schemas/editgroup'
changelog_entry:
$ref: '#/components/schemas/changelog_entry'
success:
type: object
required:
- success
- message
properties:
success:
type: boolean
example: true
message:
type: string
example: The computers did the thing successfully!
editgroup_annotation:
type: object
properties:
annotation_id:
type: string
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
minLength: 36
maxLength: 36
description: UUID (lower-case, dash-separated, hex-encoded 128-bit)
example: 86daea5b-1b6b-432a-bb67-ea97795f80fe
editgroup_id:
type: string
pattern: '[a-zA-Z2-7]{26}'
minLength: 26
maxLength: 26
description: 'Editgroup that this annotation applies to. Set automatically in
creations based on URL parameter.
'
example: q3nouwy3nnbsvo3h5klxsx4a7y
editor_id:
type: string
pattern: '[a-zA-Z2-7]{26}'
minLength: 26
maxLength: 26
description: 'Defaults to editor created the annotation via POST request.
'
example: q3nouwy3nnbsvo3h5klxsx4a7y
editor:
$ref: '#/components/schemas/editor'
description: 'Only included in GET responses; ignored in PUT or POST requests.
'
created:
type: string
format: date-time
description: 'Timestamp when annotation was first created.
'
comment_markdown:
type: string
extra:
type: object
additionalProperties: {}
description: 'Additional free-form JSON metadata that can be included as part of
the annotation (or even as the primary annotation itself). See guide
for details.
'
editgroup:
type: object
properties:
editgroup_id:
type: string
pattern: '[a-zA-Z2-7]{26}'
minLength: 26
maxLength: 26
description: 'Fatcat identifier for this editgroup. Assigned on creation.
'
example: q3nouwy3nnbsvo3h5klxsx4a7y
editor_id:
type: string
pattern: '[a-zA-Z2-7]{26}'
minLength: 26
maxLength: 26
description: 'Fatcat identifier of editor that created this editgroup.
'
example: q3nouwy3nnbsvo3h5klxsx4a7y
editor:
$ref: '#/components/schemas/editor'
description: 'Complete editor object identified by `container_id` field. Only
included in GET responses.
'
changelog_index:
type: integer
example: 1048576
format: int64
description: 'For accepted/merged editgroups, the changelog index that the accept
occurred at. WARNING: not populated in all contexts that an editgroup
could be included in a response.
'
created:
type: string
format: date-time
description: 'Timestamp when this editgroup was first created.
'
submitted:
type: string
format: date-time
description: 'Timestamp when this editgroup was most recently submitted for review.
If withdrawn, or never submitted, will be `null`.
'
description:
type: string
description: 'Comment describing the changes in this editgroup. Can be updated with
PUT request.
'
extra:
type: object
additionalProperties: {}
description: 'Free-form JSON metadata attached to this editgroup. Eg, metadata
provenance, or script user-agent details. See guide for (unenforced)
schema norms.
'
annotations:
type: array
items:
$ref: '#/components/schemas/editgroup_annotation'
description: 'Only included in GET responses, and not in all contexts. Do not
include this field in PUT or POST requests.
'
edits:
type: object
description: 'Only included in GET responses, and not in all contexts. Do not
include this field in PUT or POST requests.
'
properties:
containers:
type: array
items:
$ref: '#/components/schemas/entity_edit'
creators:
type: array
items:
$ref: '#/components/schemas/entity_edit'
files:
type: array
items:
$ref: '#/components/schemas/entity_edit'
filesets:
type: array
items:
$ref: '#/components/schemas/entity_edit'
webcaptures:
type: array
items:
$ref: '#/components/schemas/entity_edit'
releases:
type: array
items:
$ref: '#/components/schemas/entity_edit'
works:
type: array
items:
$ref: '#/components/schemas/entity_edit'
container_entity:
type: object
properties:
state:
type: string
enum:
- wip
- active
- redirect
- deleted
example: active
ident:
type: string
pattern: '[a-zA-Z2-7]{26}'
minLength: 26
maxLength: 26
description: base32-encoded unique identifier
example: q3nouwy3nnbsvo3h5klxsx4a7y
revision:
type: string
pattern: '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'
minLength: 36
maxLength: 36
description: UUID (lower-case, dash-separated, hex-encoded 128-bit)
example: 86daea5b-1b6b-432a-bb67-ea97795f80fe
redirect:
type: string
pattern: '[a-zA-Z2-7]{26}'
minLength: 26
maxLength: 26
description: base32-encoded unique identifier
example: q3nouwy3nnbsvo3h5klxsx4a7y
extra:
type: object
description: 'Free-form JSON metadata that will be stored with the other entity
metadata. See guide for (unenforced) schema conventions.
'
additionalProperties: {}
edit_extra:
type: object
description: 'Free-form JSON metadata that will be stored with specific entity edits
(eg, creation/update/delete).
'
additionalProperties: {}
name:
type: string
description: Name of the container (eg, Journal title). Required for entity creation.
example: Journal of Important Results
container_type:
type: string
description: Type of container, eg 'journal' or 'proceedings'. See Guide for list of valid types.
example: journal
publication_status:
type: string
description: Whether the container is active, discontinued, etc
example: active
publisher:
type: string
description: 'Name of the organization or entity responsible for publication. Not
the complete imprint/brand.
'
example: Society of Curious Students
issnl:
type: string
pattern: \d{4}-\d{3}[0-9X]
minLength: 9
maxLength: 9
example: 1234-5678
description: Linking ISSN number (ISSN-L). Should be valid and registered with issn.org
issne:
type: string
pattern: \d{4}-\d{3}[0-9X]
minLength: 9
maxLength: 9
example: 1234-5678
description: Electronic ISSN number (ISSN-E). Should be valid and registered with issn.org
issnp:
type: string
p
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fatcat/refs/heads/main/openapi/fatcat-containers-api-openapi.yml