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

ScholarSphere API

Penn State's next-generation institutional repository, written by Penn State University Libraries and released under MIT — not a Figshare, Dataverse or DSpace tenancy. The API is described by the Libraries' own OpenAPI 3.0.2 document with servers set to https://scholarsphere.psu.edu/api/{version}, covering ingest, collections, file upload, featured resources and a public DOI index. Penn State mints its own DataCite DOIs against the service under prefix 10.26207 as repository client psu.scholar. Access is by X_API_KEY header issued by the ScholarSphere team.

ScholarSphere API is one of 9 APIs that Pennsylvania State University publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Research Data, Research Repository, Open Access, DOI, and DataCite. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, SDKs, and authentication docs.

This API exposes 7 operations across 7 paths, organized into 6 resource areas, and defines 15 schemas. It is described by OpenAPI 3.0.2, at version 1.0.

Requests are made against a single base URL, https://scholarsphere.psu.edu/api/{version}.

7 operations 7 paths 15 schemas 2 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0
Base URL
https://scholarsphere.psu.edu/api/v1
Authentication
API Key
License
Terms of Service
Resource Areas
6

Authentication & Security 1

ScholarSphere API declares 1 security scheme for authenticating requests. An API key is passed in the header as X_API_KEY (APIKey).

  • APIKey — Key-based authorization mechanism to the API. A key is obtained fron the ScholarSphere team and is included in the header of all requests.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 2 GET, 4 POST, 1 PUT. They span 6 resource areas: Ingest, Collections, DOIs, Files, Featured Resources, Uploads. Each is listed below with its method, path, parameters, and response codes.

Ingest 1

Deposit a new work into ScholarSphere with its metadata, files and permissions.

POST
/ingest
Publishes a new work
body → 200201default
Collections 1

Create collections that group deposited works.

POST
/collections
Creates a new collection
DOIs 2

The public index of DataCite DOIs ScholarSphere knows about (Penn State prefix 10.26207).

GET
/dois
List of all DOIs
→ 200
GET
/dois/{doi}
Search for a DOI
1 param → 200404
Files 1

Attach or replace files on an existing work.

PUT
/files
Updates a file's metadata
body → 200default
Featured Resources 1

Promote a resource on the ScholarSphere home page.

POST
/featured_resources
Adds a new featured resource to the home page
body → 200201default
Uploads 1

Request a presigned destination for a direct file upload.

POST
/uploads
Requests a pre-signed URL to upload a file into ScholarSphere's S3 instance
body

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are metadata (36 properties), creator (6 properties), ingest (5 properties), errorResponse (3 properties). Each schema is shown below with its type and property counts.

doi_list
object
doi_response
array
uuid
object
1 property
id
object
1 property
metadata
object
36 properties 7 required
creator
object
6 properties 1 required
ingest
object
5 properties 3 required
uploads
object
2 properties 2 required
uploadedFile
object
permissions
object
Additional permissions for the work such as users or groups that can edit work. By default, only the depositor may edit the work after it has been uploaded.
featuredResource
errorResponse
object
3 properties 2 required
fileMetadata
object
2 properties 1 required
successResponse
object
1 property 1 required
virusCheck
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pennsylvania-state-university-scholarsphere-api-openapi.yml Raw ↑

Other APIs Pennsylvania State University publishes across the network.

Researcher Metadata Database (RMD) API
ETDA OAI-PMH Provider
Penn State Identity Federation (InCommon / Shibboleth)
Pennsylvania State University Buildings API
Pennsylvania State University Campuses API
Pennsylvania State University Events API
Pennsylvania State University Health API
Pennsylvania State University Rooms API
Where this information came from

This is an independent, third-party profile of ScholarSphere 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.