OSF

OSF Actions API

Actions represent state transitions or comments performed on reviewable or request-related resources within the OSF platform, such as Preprints, Nodes, Preprint Requests, Node Requests, and Collection Submissions. These endpoints document and facilitate moderation and administrative workflows, ensuring transparency and accountability in managing user interactions, moderation processes, and lifecycle management for various resources. Actions are categorized based on their targets: - **Review Actions**: Pertaining to moderation and review processes on Preprints. - **Node Request Actions**: Related to Node Requests (e.g., access or withdrawal requests). - **Preprint Request Actions**: Related to Preprint Requests, such as withdrawal requests. Actions require specific permissions depending on their triggers: - `submit`: Typically open, no special permissions required. - `accept`/`reject`: Require moderation or admin permissions. - `edit_comment`: Requires administrative permissions. Each successful action response returns a JSON:API formatted object containing: - **id** : The identifier of the action. - **type** : Type of action performed (e.g., `review-actions`, `node-request-actions`). - **attributes** : Information including `trigger`, `comment`, `from_state`, `to_state`, timestamps (`date_created`, `date_modified`), visibility (`visible`), and automation flag (`auto`). - **relationships** : - `creator`: User who initiated the action. - `target` : The resource the action applies to (e.g., Preprint, Node Request). - `provider` : Provider associated with the target, if applicable. Actions may fail due to various reasons, resulting in standard error responses: - `400 Bad Request`: Invalid or malformed payload. - `403 Forbidden`: Insufficient permissions to perform the action. - `404 Not Found`: The target resource does not exist or is inaccessible. - `409 Conflict`: Invalid action due to the current state of the target resource.

GitHub OpenAPI

Operations 4

GET /actions/reviews/ List Review Actions #
POST /actions/requests/nodes/ Create a Node Request Action #
POST /actions/requests/preprints/ Create a Preprint Request Action #
GET /actions/{action_id}/ Retrieve an Action by ID #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/osf/openapi/osf-actions-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-actions-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

osf-actions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OSF APIv2 Documentation Actions 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:


# --- truncated at 32 KB (46 KB total) ---
# Full source: https://artifacts.apis.io/osf/openapi/osf-actions-api-openapi.yml