OA
OSF APIv2 Documentation
40 endpointslivePublic API (ingested from its OpenAPI definition; no key required)
$Set up https://cracked-ai-pearl.vercel.app/SKILL.md, and then use Cracked to show me what I can do for OSF APIv2 Documentation.
| Endpoint | What it does | Price | Health |
|---|---|---|---|
| Root / | #### Returns A JSON object with `meta` and `links` keys. The `meta` key contains information such as a welcome message from the API, the specified version of the request, and the full representation of the current user, if authentication credentials were provided in the request. The `links` key contains links to the following entity collections: [addons](#tag/Addons), [collections](), [institution | $0.0020 per call | unknown |
| Actions /actions/ | A log can have one of many actions. The complete list of loggable actions (in the format {identifier}: {description}) is as follows: * `project_created`: A Node is created * `project_registered`: A Node is registered * `project_deleted`: A Node is deleted * `created_from`: A Node is created using an existing Node as a template * `pointer_created`: A Pointer is created * `pointer_forked`: A Pointe | $0.0020 per call | unknown |
| List all addons /addons/ | A paginated list of addons configurable with the OSF, for read purposes only. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 addons. Each resource in the array is a separate addon object. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). #### Errors This request should never retur | $0.0020 per call | unknown |
| List all citation styles /citations/styles/ | A paginated list of all standard citation styles available for rendering citations. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 citation styles. Each resource in the array is a separate citation syle and contains the full representation of the citation style object. The `links` key contains a dictionary of links that can be used fo | $0.0020 per call | unknown |
| Retrieve a citation style /citations/styles/{style_id}/ | Retrieves the details of a citation style. #### Returns Returns a JSON object with a `data` key containing the representation of the requested citation style, if the request is successful. #### Errors If the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#tag/Errors-and-Error-Codes) to understand why this reque | $0.0020 per call | unknown |
| List all Collections /collections/ | Retrieves a list collections, either public or related to the user #### Permissions Anonymous users are able to see all public collections at this endpoint. Logged in users will only be able to see their own content. Comments on private nodes are only visible to contributors and administrators on the parent node. #### Returns Returns a JSON object containing `data` and `links` keys. The `links` ke | $0.0020 per call | unknown |
| Retrieve a Collection /collections/{collection_id}/ | Retrieves a collection, if the user has appropriate permissions. #### Permissions Anonymous users are able to see all public collections at this endpoint. Logged in users will only be able to see their own content. #### Returns Returns a JSON object containing `data` and `links` keys. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). | $0.0020 per call | unknown |
| Retrieve a list of collected metadata for a collection /collections/{collection_id}/collected_metadata/ | List of user created metadata for entities within a collection. #### Permissions In order to view this metadata it must be public or a user must have read permissions for collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of nodes ids. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). | $0.0020 per call | unknown |
| Retrieve Specific Metadata for a Collection /collections/{collection_id}/collected_metadata/{cgm_id} | #### Permissions In order to view this metadata it must be public or a user must have read permissions for collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of nodes ids. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). #### Errors This request should never return an error. | $0.0020 per call | unknown |
| Retrieve subject metadata for a specific piece of metadata in a collection /collections/{collection_id}/collected_metadata/{cgm_id}/relationships/subjects/ | #### Permissions This is public for a logged out user when an entity is public. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of nodes ids. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). | $0.0020 per call | unknown |
| Retrieve subject data for a specific piece of metadata info for a collection /collections/{collection_id}/collected_metadata/{cgm_id}/subjects/ | #### Permissions In order to view these subject it must be a public collection or a user must have read permissions for collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of nodes ids. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). #### Errors This request should never return an er | $0.0020 per call | unknown |
| List All Linked Nodes for a Collection /collections/{collection_id}/linked_nodes | List of all nodes linked to the given collection. #### Permissions This returns all public nodes associated with this collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 nodes. Each resource in the array is a separate node object. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Paginat | $0.0020 per call | unknown |
| Give a Sparse List of Node Ids /collections/{collection_id}/linked_nodes/relationships/ | List of all the node ids linked to the given collection. #### Permissions This returns all public nodes associated with this collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of nodes ids. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). | $0.0020 per call | unknown |
| List All Linked Preprints for a Collection /collections/{collection_id}/linked_preprints/ | List of all preprints linked to the given collection. #### Permissions This returns all public preprints associated with this collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 nodes. Each resource in the array is a separate node object. The `links` key contains a dictionary of links that can be used for [pagination](#tag | $0.0020 per call | unknown |
| List All Linked Registrations for a Collection /collections/{collection_id}/linked_registrations/ | List of all registrations linked to the given collection. #### Permissions This returns all public registrations associated with this collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 nodes. Each resource in the array is a separate node object. The `links` key contains a dictionary of links that can be used for [paginati | $0.0020 per call | unknown |
| Give a Sparse List of Registrations Ids /collections/{collection_id}/linked_registrations/relationships/ | List of all the registration ids linked to the given collection. #### Permissions This returns all public registrations associated with this collection. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of nodes ids. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). | $0.0020 per call | unknown |
| Retrieve a comment /comments/{comment_id}/ | Retrieves the details of a comment #### Returns Returns a JSON object with a `data` key containing the representation of the requested comment, if the request was successful. If the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#tag/Errors-and-Error-Codes) to understand why this request may have failed. | $0.0020 per call | unknown |
| Retrieve a list of Draft Registrations /draft_registrations/ | Retrieve a list of all currently available Draft Registrations for that user. #### Permissions Only Draft Registration contributors may view draft registrations. #### Returns Returns a JSON object with a `data` key containing the representation of the requested draft registration, if the request is successful. If the request is unsuccessful, an `errors` key containing information about the failure | $0.0020 per call | unknown |
| Retrieve a Draft Registration /draft_registrations/{draft_id}/ | Retrieve the details of a given Draft Registration Draft Registrations contain Registration questions that will become part of the Registration. A Registration is a frozen version of the project that can never be deleted, but can be withdrawn and have it's metadata edited. If you based your Draft Registration on a Project, your original Project remains editable but will now have the Draft Registra | $0.0020 per call | unknown |
| Retreive a list Contributors from a Draft Registration /draft_registrations/{draft_id}/contributors/ | Retrieves the details of all given Contributors for a Draft Registration. Contributors are users who can make changes to the Draft Registration. Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bib | $0.0020 per call | unknown |
| Retreive a Contributor from a Draft Registration /draft_registrations/{draft_id}/contributors/{user_id}/ | Retrieves the details of a given contributor. Contributors are users who can view or edit to the Draft Registrations. Contributors are categorized as either "bibliographic" or "non-bibliographic". From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are | $0.0020 per call | unknown |
| Retrieve Institutions afilliated with a Draft Registration /draft_registrations/{draft_id}/institutions/ | Once a properly authenticated user has marked their registration as affiliated with an institution, that institution and any others added will appear in this list. | $0.0020 per call | unknown |
| Retrieve Subjects associated with a Draft Registration /draft_registrations/{draft_id}/subjects/ | This retrieves a list of subjects associated with a Draft Registration. Subjects are formatted here in a flat paginated list, but are hierarchical and nested by specificity of subject matter. | $0.0020 per call | unknown |
| Retrieve a file /files/{file_id}/ | Retrieves the details of a file (or folder) #### Returns Returns a JSON object with a `data` key containing the representation of the requested file, if the request was successful. If the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#tag/Errors-and-Error-Codes) to understand why this request may have failed. | $0.0020 per call | unknown |
| List all file versions /files/{file_id}/versions/ | A paginated list of all file versions. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 file versions. Each resource in the array is a separate file version object. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). If the request is unsuccessful, an `errors` key containing information abo | $0.0020 per call | unknown |
| Retrieve a file version /files/{file_id}/versions/{version_id}/ | Retrieves the details of a file version #### Returns Returns a JSON object with a `data` key containing the representation of the requested file, if the request was successful. If the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#tag/Errors-and-Error-Codes) to understand why this request may have failed. | $0.0020 per call | unknown |
| List all institutions /institutions/ | A paginated list of all verified institutions. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 institutions. Each resource in the array is a separate institution object. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). This request should never return an error. #### Filtering You can op | $0.0020 per call | unknown |
| Retrieve an institution /institutions/{institution_id}/ | Retrieves the details of an institution #### Returns Returns a JSON object with a `data` key containing the representation of the requested institution, if the request was successful. If the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#tag/Errors-and-Error-Codes) to understand why this request may have faile | $0.0020 per call | unknown |
| List all affiliated nodes /institutions/{institution_id}/nodes/ | A paginated list of all nodes affiliated with an institution. #### Versioning As of version `2.2`, affiliated components (in addition to affiliated top-level projects) are returned from this endpoint. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 nodes. Each resource in the array is a separate nodes object. The `links` key contains a | $0.0020 per call | unknown |
| List all affiliated registrations /institutions/{institution_id}/registrations/ | A paginated list of all registrations affiliated with an institution. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 registrations. Each resource in the array is a separate users object. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). If the request is unsuccessful, an `errors` key con | $0.0020 per call | unknown |
| List all affiliated users /institutions/{institution_id}/users/ | A paginated list of all users affiliated with an institution. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 users. Each resource in the array is a separate users object. The `links` key contains a dictionary of links that can be used for [pagination](#tag/Pagination). If the request is unsuccessful, an `errors` key containing informat | $0.0020 per call | unknown |
| Retrieve a license /license/{license_id}/ | Retrieves the details of a license. #### Returns Returns a JSON object with a `data` key containing the representation of the requested license, if the request is successful. If the request is unsuccessful, an `errors` key containing information about the failure will be returned. Refer to the [list of error codes](#tag/Errors-and-Error-Codes) to understand why this request may have failed. | $0.0020 per call | unknown |
| List all licenses /licenses/ | A paginated list of licenses. The returned licenses are sorted by their name. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 licenses. Each resource in the array is a separate license object and contains the full representation of the license, meaning additional requests to a license's detail view are not necessary. The `links` key con | $0.0020 per call | unknown |
| Retrieve a log /logs/{log_id}/ | Retrieves the details of a log. A log is permanent immutable record of a node's history. A log is created when a user performs one of many actions. See the [actions](#Logs_logs_actions) section for more details. #### Returns Returns a JSON object with a `data` key containing the representation of the requested log, if the request was successful. If the request is unsuccessful, an `errors` key cont | $0.0020 per call | unknown |
| List all nodes /nodes/ | A paginated list of nodes, representing projects and components, on the OSF. The returned nodes are those which are public or which the user has access to view. The returned nodes are sorted by their `date_modified`, with the most recently updated nodes appearing first. Registrations cannot be accessed through this endpoint (use the [registrations](#tag/Registrations) endpoints instead). #### Ret | $0.0020 per call | unknown |
| Retrieve a node /nodes/{node_id}/ | Retrieves the details of a given node (project or component). #### Permissions Only project contributors may retrieve the details of a private node. Attempting to retreive a private node for which you are not a contributor will result in a **403 Forbidden** response. Authentication is not required to view the details of a public node, as public nodes give read-only access to everyone. #### Returns | $0.0020 per call | unknown |
| List all addons /nodes/{node_id}/addons/ | A paginated list of addons connected to the given node or project. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of at most 10 addon objects. Each resource in the array is a separate addon object and contains the full representation of the addon, meaning additional requests to a addon's detail view are not necessary. The `links` key contai | $0.0020 per call | unknown |
| Retrieve an addon /nodes/{node_id}/addons/{provider}/ | Retrieve details of an individual addon connected to this node. #### Permissions NodeSettings that are attached to public nodes will give read-only access to everyone. Private nodes require explicit read permission. Write and admin access are the same for public and private nodes. Administrators on a parent node have implicit read permissions for all child nodes. Any users with write or admin acce | $0.0020 per call | unknown |
| List all addon folders /nodes/{node_id}/addons/{provider}/folders/ | A paginated list of folders retrieved from the associated third-party (provider) service. #### Permissions Folders are visible only to the user that authorized the addon. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of addon folder objects. Each resource in the array is a separate addon folder object and contains the full representation o | $0.0020 per call | unknown |
| List all child nodes /nodes/{node_id}/children/ | A paginated list of the next level child nodes for the given node. The returned nodes are sorted by their `date_modified`, with the most recently updated child nodes appearing first. The list will include child nodes that are public, as well as child nodes that are private, if the authenticated user has permission to view them. #### Returns Returns a JSON object containing `data` and `links` keys | $0.0020 per call | unknown |