v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Nodes

Create a node

Creates a new node.

On the OSF, nodes are considered projects or components. The difference between a project and a component is that a project is a top-level node, and a component is a child of a project.

Additionally, nodes have a category field that includes project as an option. The categorization determines what icon is displayed with the node on the OSF, and helps with search organization. Projects (top-level nodes) may have a category other than project, and components (children) may have a category of project.

Required

Required fields for creating a node include:

   &nbsptitle

   &nbspcategory

Note: Nodes default to private unless the public field is explicitly set to true in the request payload.

Returns

Returns a JSON object with a data key containing the representation of the created node, 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 to understand why this request may have failed.

post/nodes/

Request body

idstring

The unique identifier of the node entity.

typestring required

The type identifier of the node entity (nodes).

Example request

{
  "data": {
    "type": "nodes",
    "attributes": {
      "title": "An Excellent Project Title",
      "category": "software"
    }
  }
}

Response

Success