OSF, the Open Science Framework, is a platform for managing, sharing, and preserving research projects, files, data, and collaborations.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Osf

OSF, the Open Science Framework, is a platform for managing, sharing, and preserving research projects, files, data, and collaborations.

Base URL: https://api.test.osf.io/v2
Auth: bearer (pass your key via the apiKey input)

Operations

base_read — GET / — Root
logs_actions — GET /actions/ — Actions
addons_list — GET /addons/ — List all addons
citations_styles_list — GET /citations/styles/ — List all citation styles
citations_styles_read — GET /citations/styles/{style_id}/ — Retrieve a citation style
collections_list — GET /collections/ — List all Collections

Inputs

apiKey — your osf API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: base_read
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: base_read, logs_actions, addons_list, citations_styles_list, citations_styles_read, collections_list
`style_id`	string	no	—	Path parameter style_id (required by some operations).
`query`	string	no	—	Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request.