OSF

OSF Resources API

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.

Documentation GitHub OpenAPI

Operations 6

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 #

Specifications

⚙

OpenAPI

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

Work with this as data

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/osf:osf-resources-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: OSF APIv2 Documentation Resources API
  description: This is the official documentation for the OSF (Open Science Framework) API v2.
  version: '2.0'
  termsOfService: https://osf.io/terms_of_use/
  contact:
    name: OSF Support Team
    email: support@osf.io
    url: https://help.osf.io/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://cdn.cos.io/media/images/cos_center_logo_small.original.png
    backgroundColor: transparent
servers:
- url: https://api.test.osf.io/v2
tags:
- name: Resources
  description: Resources are structured data artifacts associated with a Registration.
paths:
  /registrations/{registration_id}/resources/:
    get:
      summary: List Related Resources for a Registration
      description: 'Retrieve a list of resources associated with a specific registration.

        This endpoint returns a list of nodes, preprints, and other resources that have been explicitly linked to the registration as related resources. These resources help provide additional context, background, or supporting materials for the registration.

        #### Permissions

        - Public registrations expose their related resources publicly.

        - Private registrations require the user to have read access to view related resources.


        #### Returns

        - A JSON object with a `data` key containing an array of related resources.

        - Related resources may include nodes, preprints, and other OSF resources.'
      tags:
      - Resources
      operationId: registrations_resources_list
      parameters:
      - in: path
        name: registration_id
        required: true
        description: The unique identifier of the registration.
        schema:
          type: string
      - in: query
        name: page
        description: Page number of results to return (pagination).
        schema:
          type: integer
      responses:
        '200':
          description: Successfully retrieved related resources for this registration.
          content:
            application/json:
              example:
                data:
                - id: xyz123
                  type: nodes
                  attributes:
                    title: Supporting Project A
                    description: Dataset related to the registration study
                    public: true
                    date_created: '2024-01-10T10:00:00Z'
                    date_modified: '2024-03-22T15:30:00Z'
                  relationships:
                    contributors:
                      links:
                        related:
                          href: https://api.osf.io/v2/nodes/xyz123/contributors/
                    affiliated_institutions:
                      links:
                        related:
                          href: https://api.osf.io/v2/nodes/xyz123/institutions/
                  links:
                    self: https://api.osf.io/v2/nodes/xyz123/
                meta:
                  version: '2.0'
        '401':
          description: Unauthorized. Authentication is required to access related resources for this registration.
        '403':
          description: Forbidden. You do not have permission to view the related resources for this registration.
        '404':
          description: Not Found. No registration matches the given ID.
  /resources/:
    get:
      summary: List resources
      description: Retrieve a list of resources associated with registrations.
      tags:
      - Resources
      operationId: listResources
      responses:
        '200':
          description: Successful retrieval of resource list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Array of resource objects.
                    items:
                      type: object
                      required:
                      - id
                      - type
                      - attributes
                      - relationships
                      properties:
                        id:
                          type: string
                          example: abc123
                          description: Unique identifier for the resource.
                        type:
                          type: string
                          example: resources
                          description: 'The type of this object: `resources`.'
                        attributes:
                          type: object
                          description: Resource metadata.
                          properties:
                            date_created:
                              type: string
                              format: date-time
                              example: '2024-01-01T00:00:00Z'
                              description: When the resource was created.
                            date_modified:
                              type: string
                              format: date-time
                              example: '2024-01-02T00:00:00Z'
                              description: When the resource was last updated.
                            description:
                              type: string
                              example: Dataset resource
                              description: A short summary of the resource.
                            resource_type:
                              type: string
                              example: data
                              description: "The category of the resource. Valid values include:\n - data\n - analytic_code\n - materials\n - papers\n - supplements\n"
                            finalized:
                              type: boolean
                              example: true
                              description: Whether the resource is finalized and no longer editable.
                            pid:
                              type: string
                              example: 10.1234/resource.5678
                              description: A persistent identifier (DOI) assigned to this resource.
                        relationships:
                          type: object
                          description: Relationships for the resource.
                          properties:
                            registration:
                              type: object
                              description: The registration associated with the resource.
                              properties:
                                data:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: reg123
                                      description: ID of the related registration.
                                    type:
                                      type: string
                                      example: registrations
                                      description: Type of the related object.
                        links:
                          type: object
                          description: Related API URLs for this resource.
                          properties:
                            self:
                              type: string
                              example: https://api.osf.io/v2/resources/abc123/
                              description: URL to the resource detail.
                  meta:
                    type: object
                    description: Metadata for pagination.
                    properties:
                      total:
                        type: integer
                        example: 1
                        description: Total number of resources.
                      per_page:
                        type: integer
                        example: 10
                        description: Results per page.
                      page:
                        type: integer
                        example: 1
                        description: Current page number.
        '401':
          description: Authentication required.
        '403':
          description: Permission denied.
    post:
      summary: Create a new resource
      description: Create a new resource associated with a registration.
      tags:
      - Resources
      operationId: createResource
      responses:
        '201':
          description: Successfully created a new resource.
          content:
            application/json:
              schema:
                description: A resource associated with a registration, such as datasets, materials, code, or papers.
                type: object
                required:
                - data
                properties:
                  data:
                    type: object
                    required:
                    - id
                    - type
                    - attributes
                    properties:
                      id:
                        type: string
                        description: Unique identifier of the resource.
                        example: abc123
                      type:
                        type: string
                        description: The type of the resource object.
                        example: resources
                      attributes:
                        type: object
                        properties:
                          date_created:
                            type: string
                            format: date-time
                            example: '2024-01-01T00:00:00Z'
                            description: The date the resource was created.
                          date_modified:
                            type: string
                            format: date-time
                            example: '2024-01-02T00:00:00Z'
                            description: The date the resource was last modified.
                          description:
                            type: string
                            description: A brief description of the resource.
                            example: Dataset resource for analysis of trial results
                          resource_type:
                            type: string
                            description: 'The type of the resource. Acceptable values include:

                              - data

                              - analytic_code

                              - materials

                              - papers

                              - supplements

                              '
                            example: data
                          finalized:
                            type: boolean
                            description: Indicates whether the resource has been finalized.
                            example: true
                          pid:
                            type: string
                            description: Persistent Identifier (PID) assigned to the resource.
                            example: 10.1234/osf.io/abcde
                      relationships:
                        type: object
                        properties:
                          registration:
                            type: object
                            properties:
                              data:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: reg123
                                    description: The unique identifier of the registration.
                                  type:
                                    type: string
                                    example: registrations
                                    description: Type for the registration.
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                            example: https://api.osf.io/v2/resources/abc123/
                            description: The canonical API endpoint for this resource.
        '400':
          description: Validation error or invalid data.
        '401':
          description: Authentication required.
        '403':
          description: Permission denied.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  required:
                  - type
                  - attributes
                  - relationships
                  properties:
                    type:
                      type: string
                      example: resources
                      description: Must be `resources`.
                    attributes:
                      type: object
                      description: Metadata about the new resource.
                      required:
                      - description
                      - resource_type
                      properties:
                        description:
                          type: string
                          example: Dataset resource
                          description: Short text describing the resource.
                        resource_type:
                          type: string
                          example: data
                          description: Type of resource (e.g., data, materials).
                    relationships:
                      type: object
                      description: Relationships for the resource.
                      properties:
                        registration:
                          type: object
                          description: The registration this resource is linked to.
                          properties:
                            data:
                              type: object
                              required:
                              - type
                              - id
                              properties:
                                type:
                                  type: string
                                  example: registrations
                                  description: Must be `registrations`.
                                id:
                                  type: string
                                  example: reg123
                                  description: ID of the related registration.
        description: JSON:API-compliant resource creation payload.
        required: true
  /resources/{resource_id}/:
    get:
      summary: Retrieve a resource
      description: 'Retrieve the full metadata for a specific resource associated with a registration.


        A resource may include datasets, materials, code, papers, or supplements.'
      tags:
      - Resources
      operationId: getResource
      parameters:
      - name: resource_id
        in: path
        required: true
        description: The unique identifier of the resource.
        schema:
          type: string
      responses:
        '200':
          description: Successful retrieval of the resource.
          content:
            application/json:
              schema:
                description: A resource associated with a registration, such as datasets, materials, code, or papers.
                type: object
                required:
                - data
                properties:
                  data:
                    type: object
                    required:
                    - id
                    - type
                    - attributes
                    properties:
                      id:
                        type: string
                        description: Unique identifier of the resource.
                        example: abc123
                      type:
                        type: string
                        description: The type of the resource object.
                        example: resources
                      attributes:
                        type: object
                        properties:
                          date_created:
                            type: string
                            format: date-time
                            example: '2024-01-01T00:00:00Z'
                            description: The date the resource was created.
                          date_modified:
                            type: string
                            format: date-time
                            example: '2024-01-02T00:00:00Z'
                            description: The date the resource was last modified.
                          description:
                            type: string
                            description: A brief description of the resource.
                            example: Dataset resource for analysis of trial results
                          resource_type:
                            type: string
                            description: 'The type of the resource. Acceptable values include:

                              - data

                              - analytic_code

                              - materials

                              - papers

                              - supplements

                              '
                            example: data
                          finalized:
                            type: boolean
                            description: Indicates whether the resource has been finalized.
                            example: true
                          pid:
                            type: string
                            description: Persistent Identifier (PID) assigned to the resource.
                            example: 10.1234/osf.io/abcde
                      relationships:
                        type: object
                        properties:
                          registration:
                            type: object
                            properties:
                              data:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: reg123
                                    description: The unique identifier of the registration.
                                  type:
                                    type: string
                                    example: registrations
                                    description: Type for the registration.
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                            example: https://api.osf.io/v2/resources/abc123/
                            description: The canonical API endpoint for this resource.
        '401':
          description: Authentication required.
        '403':
          description: Permission denied.
        '404':
          description: Resource not found.
    patch:
      summary: Update a resource
      description: 'Update one or more metadata fields of a specific resource.


        Only the fields provided in the request payload will be updated.'
      tags:
      - Resources
      operationId: updateResource
      parameters:
      - name: resource_id
        in: path
        required: true
        description: The unique identifier of the resource to update.
        schema:
          type: string
      responses:
        '200':
          description: Resource updated successfully.
          content:
            application/json:
              schema:
                description: A resource associated with a registration, such as datasets, materials, code, or papers.
                type: object
                required:
                - data
                properties:
                  data:
                    type: object
                    required:
                    - id
                    - type
                    - attributes
                    properties:
                      id:
                        type: string
                        description: Unique identifier of the resource.
                        example: abc123
                      type:
                        type: string
                        description: The type of the resource object.
                        example: resources
                      attributes:
                        type: object
                        properties:
                          date_created:
                            type: string
                            format: date-time
                            example: '2024-01-01T00:00:00Z'
                            description: The date the resource was created.
                          date_modified:
                            type: string
                            format: date-time
                            example: '2024-01-02T00:00:00Z'
                            description: The date the resource was last modified.
                          description:
                            type: string
                            description: A brief description of the resource.
                            example: Dataset resource for analysis of trial results
                          resource_type:
                            type: string
                            description: 'The type of the resource. Acceptable values include:

                              - data

                              - analytic_code

                              - materials

                              - papers

                              - supplements

                              '
                            example: data
                          finalized:
                            type: boolean
                            description: Indicates whether the resource has been finalized.
                            example: true
                          pid:
                            type: string
                            description: Persistent Identifier (PID) assigned to the resource.
                            example: 10.1234/osf.io/abcde
                      relationships:
                        type: object
                        properties:
                          registration:
                            type: object
                            properties:
                              data:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: reg123
                                    description: The unique identifier of the registration.
                                  type:
                                    type: string
                                    example: registrations
                                    description: Type for the registration.
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                            example: https://api.osf.io/v2/resources/abc123/
                            description: The canonical API endpoint for this resource.
        '400':
          description: Validation error or malformed request data.
        '401':
          description: Authentication required.
        '403':
          description: Permission denied.
        '404':
          description: Resource not found.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - data
              properties:
                data:
                  type: object
                  required:
                  - id
                  - type
                  - attributes
                  properties:
                    id:
                      type: string
                      example: abc123
                      description: The ID of the resource being updated.
                    type:
                      type: string
                      example: resources
                      description: The resource type — must be `"resources"`.
                    attributes:
                      type: object
                      properties:
                        description:
                          type: string
                          example: Updated dataset description.
                          description: A short description of the resource.
                        resource_type:
                          type: string
                          example: materials
                          description: 'Type of the resource. Allowed values:

                            - data

                            - analytic_code

                            - materials

                            - papers

                            - supplements

                            '
                        finalized:
                          type: boolean
                          example: true
                          description: Whether the resource is finalized (locked for editing).
                        pid:
                          type: string
                          example: 10.5678/resource.9012
                          description: A persistent identifier (e.g. DOI) for the resource.
        description: A JSON:API compliant object describing the updates.
        required: true
    delete:
      summary: Delete a resource
      description: 'Permanently delete a specific resource.


        Finalized resources or those linked to active registrations may not be deletable.'
      tags:
      - Resources
      operationId: deleteResource
      parameters:
      - name: resource_id
        in: path
        required: true
        description: The unique identifier of the resource to delete.
        schema:
          type: string
      responses:
        '204':
          description: Resource deleted successfully. No content returned.
        '401':
          description: Authentication required.
        '403':
          description: Permission denied or resource cannot be deleted.
        '404':
          description: Resource not found.
x-tagGroups:
- name: Welcome
  tags:
  - Introduction
  - General Usage
  - Authentication
  - Pagination
  - Versioning
  - Filtering
  - Sparse Fieldsets
  - Embedding
  - Request Formatting
  - Errors & Error Codes
  - Entities & Entity Collections
- name: API Reference
  tags:
  - Actions
  - Addons
  - Applications
  - Base
  - CEDAR Metadata
  - Citations
  - Comments
  - Collections
  - Collection Submissions
  - Collection Submissions Actions
  - Collection Providers
  - Custom Metadata
  - Files
  - Licenses
  - Logs
  - Institutions
  - Identifiers
  - Registration Schemas
  - Registration Schema Blocks
  - Schema Responses
  - Schema Response Actions
  - Nodes
  - Notification Subscriptions
  - Preprints
  - Preprint Providers
  - Draft Registrations
  - Registrations
  - Registration Providers
  - Regions
  - OAuth Scopes
  - Taxonomies
  - Tokens
  - Users
  - View Only Links
  - Wikis
  - Subjects
  - GUIDs
  - Requests
  - Resources