How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

University of Chicago Gen3 indexd — index API

Associate a file (object) with a unique id, and store some basic metadata.

University of Chicago Gen3 indexd — index API is one of 44 APIs that University of Chicago publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Index. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 17 operations across 8 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against a single base URL, https://gen3.datacommons.io/.

17 operations 8 paths 16 schemas 3 DELETE5 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gen3.datacommons.io/
Authentication
OAuth 2.0
License
Terms of Service
Resource Areas
1

Authentication & Security 1

University of Chicago Gen3 indexd — index API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 17

Across 8 paths, the API surfaces 17 operations — 3 DELETE, 5 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

index 17

Associate a file (object) with a unique id, and store some basic metadata.

POST
/index
Add a new entry to the index
addEntry body → 200400
GET
/index
List all records
listEntries 14 params → 200
POST
/index/blank
Create a blank record
createBlankEntry body → 201400
POST
/index/blank/{GUID}
Create a new, blank version for the document associated to the provided uuid.
addNewBlankVersion 1 param body → 201400404
PUT
/index/blank/{GUID}
Update only hashes, size and optionally urls and authz for blank index
updateBlankEntry 2 params body → 200400
GET
/index/{GUID}
Get the metadata associated with the given id. Resolves bundle id.
getIndexEntry 2 params → 200400
POST
/index/{GUID}
Add new version for the document associated to the provided uuid.
addNewVersion 1 param body → 200400
PUT
/index/{GUID}
Update an existing entry in the index
updateEntry 2 params body → 200400
DELETE
/index/{GUID}
Delete an entry from the index
deleteEntry 2 params → 400200
GET
/index/{GUID}/aliases
Get all aliases associated with this GUID
getAliases 1 param → 200404
POST
/index/{GUID}/aliases
Append new aliases to this GUID
addNewAliases 1 param body → 200400404
PUT
/index/{GUID}/aliases
Replace all aliases for this GUID
updateAliases 1 param body → 200400404
DELETE
/index/{GUID}/aliases
Delete all aliases for this GUID
deleteAllAliases 1 param → 200404
DELETE
/index/{GUID}/aliases/{ALIAS}
Delete one alias for this GUID
deleteOneAlias 2 params → 200404
GET
/index/{GUID}/latest
Get the metadata of the latest index record version associated with the given id
getLatestVersion 2 params → 200400
GET
/index/{GUID}/versions
Get the metadata of index record versions associated with the given id, in the order the versions were created
getAllVersions 1 param → 200400
PUT
/index/{GUID}/versions
Update metadata for all versions of this record. Only some metadata fields can be updated in this way.
updateAllVersions 1 param body → 200400403404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are OutputInfo (16 properties), VersionInputInfo (14 properties), InputInfo (12 properties), ListRecords (12 properties). Each schema is shown below with its type and property counts.

HashInfo
object
6 properties
UpdateInputInfo
object
7 properties
ListRecords
object
12 properties
ErrorResponse
object
An object that can optionally include information about the error.
2 properties
DID
string
BulkOutputInfo
array
VersionInputInfo
object
14 properties 4 required
AliasInfo
object
1 property
UpdateBlankInputInfo
object
4 properties
OutputRef
object
3 properties
UpdateAllVersionsInputInfo
object
2 properties
UUID
string
InputBlankVersionInfo
object
4 properties
InputInfo
object
12 properties 4 required
InputBlankInfo
object
3 properties
OutputInfo
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

university-of-chicago-index-api-openapi.yml Raw ↑

Other APIs University of Chicago publishes across the network.

University of Chicago Shibboleth Identity Provider — InCommon SAML Metadata
Knowledge@UChicago Repository REST API
Knowledge@UChicago OAI-PMH Endpoint
OCHRE Data Service API
University of Chicago Library IIIF Presentation API
University of Chicago Library IIIF Image API
University of Chicago Library Catalog API (VuFind)
University of Chicago Gen3 Fence — admin/user API
University of Chicago Gen3 indexd — alias API
University of Chicago Gen3 indexd — bulk API
University of Chicago Gen3 indexd — bundle API
University of Chicago Gen3 Peregrine — core metadata API
Where this information came from

This is an independent, third-party profile of University of Chicago Gen3 indexd — index API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.