# OSF APIv2 Documentation API

> OSF APIv2 Documentation API on Apizie: 156 endpoints (Root, Actions, List all addons, List all citation styles, …) returned as clean JSON through one API key. 156 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/open-data:osf/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:osf`
- Category: Open Data
- Status: live
- Source: https://osf.io/support
- Page: https://zieapi.vercel.app/api/open-data/osf
- OpenAPI: https://zieapi.vercel.app/api/open-data/osf/openapi.json



## Endpoints

### Root
`GET https://zieapi.vercel.app/v1/open-data:osf/base-read`

### Actions
`GET https://zieapi.vercel.app/v1/open-data:osf/logs-actions`

### List all addons
`GET https://zieapi.vercel.app/v1/open-data:osf/addons-list`

### List all citation styles
`GET https://zieapi.vercel.app/v1/open-data:osf/citations-styles-list`

### Retrieve a citation style
`GET https://zieapi.vercel.app/v1/open-data:osf/citations-styles-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| style_id | string | yes | The unique identifier of the citation style. |

### List all Collections
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-list`

### Create a Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-detail`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### Delete a Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### Retrieve a list of collected metadata for a collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-metadata-registrations-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### Add Metadata or Subjects to a Entity in a Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-add-metadata`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| body | object | yes | JSON request body |

### Retrieve Specific Metadata for a Collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-metadata-registrations-detail`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| cgm_id | string | yes | A short id for that piece of metadata |

### Add Metadata or Subjects to an Entity in a Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-metadata-detail`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| cgm_id | string | yes | A short id for that piece of metadata |
| body | object | yes | JSON request body |

### Delete Collection Metadata from entitiy
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-metadata-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| cgm_id | string | yes | A short id for that piece of metadata |

### Retrieve subject metadata for a specific piece of metadata in a collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-metadata-subjects-relationships`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| cgm_id | string | yes | A short id for that piece of metadata |

### Update subjects for a specific piece of metadata in a collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-metadata-subjects-relationships-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| cgm_id | string | yes | A short id for that piece of metadata |
| body | object | yes | JSON request body |

### Retrieve subject data for a specific piece of metadata info for a collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-collected-metadata`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| cgm_id | string | yes | A short id for that piece of metadata |

### List All Linked Nodes for a Collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-linked-nodes-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### Give a Sparse List of Node Ids
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-linked-nodes-relationships-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### Link Nodes to Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-linked-nodes-relationships`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| body | object | yes | JSON request body |

### Remove Nodes From Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-linked-nodes-relationships-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| body | object | yes | JSON request body |

### List All Linked Preprints for a Collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-linked-preprints-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### List All Linked Registrations for a Collection
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-linked-registrations-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### Give a Sparse List of Registrations Ids
`GET https://zieapi.vercel.app/v1/open-data:osf/collections-linked-registrations-relationships-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |

### Link Registrations to Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-linked-registrations-relationships`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| body | object | yes | JSON request body |

### Remove Registrations From Collection
`POST https://zieapi.vercel.app/v1/open-data:osf/collections-linked-registrations-relationships-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | A short id for that collection |
| body | object | yes | JSON request body |

### Retrieve a comment
`GET https://zieapi.vercel.app/v1/open-data:osf/comments-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The unique identifier of the comment you wish to retrieve. |

### Update a comment
`POST https://zieapi.vercel.app/v1/open-data:osf/comments-put`

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The unique identifier of the comment you wish to update. |
| body | object | yes | JSON request body |

### Delete a comment
`POST https://zieapi.vercel.app/v1/open-data:osf/comments-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The unique identifier of the comment you wish to delete. |

### Retrieve a list of Draft Registrations
`GET https://zieapi.vercel.app/v1/open-data:osf/draft-registrations-read`

### Create a Draft Registration
`POST https://zieapi.vercel.app/v1/open-data:osf/draft-registrations-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a Draft Registration
`GET https://zieapi.vercel.app/v1/open-data:osf/get-draft-registrations-draft-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the draft registration. |

### Update a Draft Registration
`POST https://zieapi.vercel.app/v1/open-data:osf/patch-draft-registrations-draft-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the draft registration. |
| body | object | yes | JSON request body |

### Delete a draft registration
`POST https://zieapi.vercel.app/v1/open-data:osf/delete-draft-registrations-draft-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the draft registration. |

### Retreive a list Contributors from a Draft Registration
`GET https://zieapi.vercel.app/v1/open-data:osf/draft-registration-contributors-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the Draft Registration. |

### Add a contributor to a Draft Registration
`POST https://zieapi.vercel.app/v1/open-data:osf/draft-registration-contributors-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the Draft Registration. |
| body | object | yes | JSON request body |

### Retreive a Contributor from a Draft Registration
`GET https://zieapi.vercel.app/v1/open-data:osf/get-draft-registrations-draft-id-contributors-user-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the Draft Registration. |
| user_id | string | yes | The unique identifier of the Contributor. |

### Retrieve Institutions afilliated with a Draft Registration
`GET https://zieapi.vercel.app/v1/open-data:osf/get-draft-registrations-draft-id-institutions`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the draft registration. |

### Retrieve Subjects associated with a Draft Registration
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-draft-registrations-subjects`

| Parameter | Type | Required | Description |
|---|---|---|---|
| draft_id | string | yes | The unique identifier of the draft registration. |

### Retrieve a file
`GET https://zieapi.vercel.app/v1/open-data:osf/files-detail`

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier of the file you wish to retrieve. |

### Update a file
`POST https://zieapi.vercel.app/v1/open-data:osf/files-patch`

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier of the file you wish to update. |
| body | object | yes | JSON request body |

### List all file versions
`GET https://zieapi.vercel.app/v1/open-data:osf/files-versions`

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier of the file from which you want to retrieve versions. |

### Retrieve a file version
`GET https://zieapi.vercel.app/v1/open-data:osf/files-version-detail`

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier of the file from which you want to retrieve versions. |
| version_id | string | yes | The file version number you want to retrieve. |

### List all institutions
`GET https://zieapi.vercel.app/v1/open-data:osf/institutions-list`

### Retrieve an institution
`GET https://zieapi.vercel.app/v1/open-data:osf/institutions-detail`

| Parameter | Type | Required | Description |
|---|---|---|---|
| institution_id | string | yes | The unique identifier of the institution you wish to retrieve. |

### List all affiliated nodes
`GET https://zieapi.vercel.app/v1/open-data:osf/institutions-node-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| institution_id | string | yes | The unique identifier of the institution you wish to retrieve. |

### List all affiliated registrations
`GET https://zieapi.vercel.app/v1/open-data:osf/institutions-registration-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| institution_id | string | yes | The unique identifier of the institution you wish to retrieve. |

### List all affiliated users
`GET https://zieapi.vercel.app/v1/open-data:osf/institutions-users-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| institution_id | string | yes | The unique identifier of the institution you wish to retrieve. |

### Retrieve a license
`GET https://zieapi.vercel.app/v1/open-data:osf/licenses-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| license_id | string | yes | The unique identifier of the license. |

### List all licenses
`GET https://zieapi.vercel.app/v1/open-data:osf/license-list`

### Retrieve a log
`GET https://zieapi.vercel.app/v1/open-data:osf/logs-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| log_id | string | yes | The unique identifier of the log you wish to retrieve. |

### List all nodes
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-list`

### Create a node
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a node
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Update a node
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-partial-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| body | object | yes | JSON request body |

### Delete a node
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all addons
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-addons-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Retrieve an addon
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-addon-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| provider | string | yes | The unique identifier of the addon. |

### Update an addon
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-node-addon-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| provider | string | yes | The unique identifier of the addon. |
| body | object | yes | JSON request body |

### List all addon folders
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-addons-folders-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| provider | string | yes | The unique identifier of the provider |

### List all child nodes
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-children-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Create a child node
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-children-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| body | object | yes | JSON request body |

### Retrieve citation details
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-citation-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Retrieve a styled citation
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-citation-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| style_id | string | yes | The unique identifier of the citation style. |
| node_id | string | yes | The unique identifier of the node. |

### List all comments
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-comments-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Create a comment
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-comment-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node you want to comment on. |
| body | object | yes | JSON request body |

### List all contributors
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-contributors-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Create a contributor
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-contributors-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| body | object | yes | JSON request body |

### Retrieve a contributor
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-contributors-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| user_id | string | yes | The unique identifier of the user. |

### Update a contributor
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-contributors-partial-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| user_id | string | yes | The unique identifier of the user. |
| body | object | yes | JSON request body |

### Delete a contributor
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-contributors-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| user_id | string | yes | The unique identifier of the user. |

### List all draft registrations
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-draft-registrations-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Create a draft registration based on your current project Node.
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-draft-registrations-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| body | object | yes | JSON request body |

### Retrieve a Draft Registration
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-draft-registrations-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| draft_id | string | yes | The unique identifier of the draft registration. |

### Update a draft registration
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-draft-registrations-partial-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| draft_id | string | yes | The unique identifier of the draft registration. |
| body | object | yes | JSON request body |

### Delete a draft registration
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-draft-registrations-delete`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| draft_id | string | yes | The unique identifier of the draft registration. |

### List all storage providers
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-providers-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Retrieve a storage provider
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-providers-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| provider | string | yes | The unique identifier of the storage provider. |

### List all node files
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-files-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| provider | string | yes | The unique identifier of the storage provider. |

### Retrieve a file
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-files-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| provider | string | yes | The unique identifier of the storage provider. |
| path | string | yes | The unique identifier of the file path. |

### List all forks of this node
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-forks-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Create a fork of this node
`POST https://zieapi.vercel.app/v1/open-data:osf/nodes-forks-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| body | object | yes | JSON request body |

### List all identifiers
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-identifiers-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all institutions
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-institutions-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all linked nodes
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-linked-nodes-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all logs
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-logs-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all preprints
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-preprints-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all registrations
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-registrations-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all view only links
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-view-only-links-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### Retrieve a view only link
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-view-only-links-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |
| link_id | string | yes | The unique identifier of the view only link. |

### List all wikis
`GET https://zieapi.vercel.app/v1/open-data:osf/nodes-wikis-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| node_id | string | yes | The unique identifier of the node. |

### List all preprint providers
`GET https://zieapi.vercel.app/v1/open-data:osf/preprint-provider-list`

### Retrieve a preprint provider
`GET https://zieapi.vercel.app/v1/open-data:osf/preprint-provider-detail`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_provider_id | string | yes | The unique identifier of the preprint provider. |

### List all licenses
`GET https://zieapi.vercel.app/v1/open-data:osf/preprint-provider-licenses-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_provider_id | string | yes | The unique identifier of the preprint provider. |

### List all preprints
`GET https://zieapi.vercel.app/v1/open-data:osf/preprint-providers-preprints-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_provider_id | string | yes | The unique identifier of the preprint provider. |

### List all taxonomies
`GET https://zieapi.vercel.app/v1/open-data:osf/preprint-provider-taxonomies-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_provider_id | string | yes | The unique identifier of the preprint provider. |

### List all preprints
`GET https://zieapi.vercel.app/v1/open-data:osf/preprints-list`

### Create a preprint
`POST https://zieapi.vercel.app/v1/open-data:osf/preprints-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a preprint
`GET https://zieapi.vercel.app/v1/open-data:osf/preprints-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_id | string | yes | The unique identifier of the preprint. |

### Update a preprint
`POST https://zieapi.vercel.app/v1/open-data:osf/preprints-partial-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_id | string | yes | The unique identifier of the preprint. |
| body | object | yes | JSON request body |

### List all Bibliographic Contributors
`GET https://zieapi.vercel.app/v1/open-data:osf/preprints-bibliographic-contributors-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_id | string | yes | The unique identifier of the preprint. |

### Retrieve citation details
`GET https://zieapi.vercel.app/v1/open-data:osf/preprints-citation-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_id | string | yes | The unique identifier of the preprint whose citation you wish to retrieve. |

### Retrieve a styled citation
`GET https://zieapi.vercel.app/v1/open-data:osf/preprints-citation-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| style_id | string | yes | The unique identifier of the citation style. |
| preprint_id | string | yes | The unique identifier of the preprint. |

### List all Contributors for a Preprint
`GET https://zieapi.vercel.app/v1/open-data:osf/preprints-contributors-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_id | string | yes | The unique identifier of the preprint. |

### Create a Contributor
`POST https://zieapi.vercel.app/v1/open-data:osf/preprints-contributors-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_id | string | yes | The unique identifier of the Preprint. |
| body | object | yes | JSON request body |

### Retrieve a contributor
`GET https://zieapi.vercel.app/v1/open-data:osf/preprints-contributor-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| preprint_id | string | yes | The unique identifier of the Preprint. |
| user_id | string | yes | The unique identifier of the user. |

### List all registrations
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-list`

### Retrieve a registration
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |

### Update a registration
`POST https://zieapi.vercel.app/v1/open-data:osf/registrations-partial-update`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |
| body | object | yes | JSON request body |

### List all child registrations
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-children-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |

### List all citation styles
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-citations-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |

### Retrieve a citation
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-citation-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |
| citation_id | string | yes | The unique identifier of the citation. |

### List all comments
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-comments-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |

### List all contributors
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-contributors-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |

### Retrieve a contributor
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-contributors-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |
| user_id | string | yes | The unique identifier of the user. |

### List all storage providers
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-providers-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |

### List all files
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-files-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |
| provider | string | yes | The unique identifier of the storage provider. |

### Retrieve a file
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-files-read`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |
| provider | string | yes | The unique identifier of the storage provider. |
| path | string | yes | The unique identifier of the file path. |

### List all forks
`GET https://zieapi.vercel.app/v1/open-data:osf/registrations-forks-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |

### Create a fork
`POST https://zieapi.vercel.app/v1/open-data:osf/registrations-forks-create`

| Parameter | Type | Required | Description |
|---|---|---|---|
| registration_id | string | yes | The unique identifier of the registration. |
| body | object | yes | JSON request body |

…and 36 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:osf/base-read" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the OSF APIv2 Documentation API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:osf/base-read with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the OSF APIv2 Documentation API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the OSF APIv2 Documentation API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:osf.

### What is the status of the OSF APIv2 Documentation API?
Live: works with just an Apizie key