# OSF Resources API

**Canonical:** https://apis.io/apis/osf/osf-resources-api/  
**Provider:** OSF — https://apis.io/providers/osf/  
**Base URL:** https://api.osf.io  
**Documentation:** https://developer.osf.io

OSF Resources API is one of 41 APIs that [OSF](https://apis.io/providers/osf/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Resources. The published artifact set on APIs.io includes an OpenAPI specification.

Resources are structured data artifacts associated with a Registration. These can include datasets, analytic code, materials, papers, or supplementary files that contribute to the outcomes of a study or project. Resources are part of the registration’s metadata and support reproducibility, data sharing, and transparency in research. Each Resource can have an optional Persistent Identifier (PID) such as a DOI, and can be marked as finalized, indicating it is ready for public dissemination or archival. Resources are grouped under a Registration and contribute to Open Practice Badges when relevant artifacts are provided. Resources are managed through the API endpoints to: - **Create** new resources for a Registration (e.g., data, code, papers) - **List** existing resources linked to a Registration - **Retrieve** details about an individual resource - **Update** a resource’s description, type, or PID - **Finalize** a resource to prevent further changes (once validated) **Note**: Once a resource is finalized, it cannot be edited or deleted. ### Resource Types - `data`: Raw or processed datasets related to the research - `analytic_code`: Code or scripts used for analysis - `materials`: Research materials, such as instruments or questionnaires - `papers`: Manuscripts or published papers - `supplements`: Supplementary materials that enhance understanding of the research **Permissions**: - Read access requires view permissions on the parent Registration. - Write access requires edit permissions on the parent Registration.

## Operations (6)

| Method | Path | Summary |
|---|---|---|
| GET | `/registrations/{registration_id}/resources/` | List Related Resources for a Registration |
| GET | `/resources/` | List resources |
| POST | `/resources/` | Create a new resource |
| GET | `/resources/{resource_id}/` | Retrieve a resource |
| PATCH | `/resources/{resource_id}/` | Update a resource |
| DELETE | `/resources/{resource_id}/` | Delete a resource |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/osf/openapi/osf-resources-api-openapi.yml

## Other OSF APIs (12)

- [OSF API](https://apis.io/apis/osf/osf-api/)
- [OSF Actions API](https://apis.io/apis/osf/osf-actions-api/)
- [OSF Applications API](https://apis.io/apis/osf/osf-applications-api/)
- [OSF Base API](https://apis.io/apis/osf/osf-base-api/)
- [OSF CEDAR Metadata API](https://apis.io/apis/osf/osf-cedar-metadata-api/)
- [OSF Citations API](https://apis.io/apis/osf/osf-citations-api/)
- [OSF Collection Providers API](https://apis.io/apis/osf/osf-collection-providers-api/)
- [OSF Collection Submission Actions API](https://apis.io/apis/osf/osf-collection-submission-actions-api/)
- [OSF Collection Submissions API](https://apis.io/apis/osf/osf-collection-submissions-api/)
- [OSF Collections API](https://apis.io/apis/osf/osf-collections-api/)
- [OSF Comments API](https://apis.io/apis/osf/osf-comments-api/)
- [OSF Contributors API](https://apis.io/apis/osf/osf-contributors-api/)

## Tags

Resources

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/osf/osf-resources-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/osf/.