COcodepen
Pens

Create a Pen

Starter files when files is omitted; .codepen/pen.config.json is added when the caller does not supply one. The title defaults to "Untitled" and access to the key owner's default privacy. Anything but Public needs a PRO plan.

The answer is the Pen with the first version's build; wait in the body or the query bounds how long the request waits for it.

post/v2/pens

Request

  • Base URL
    https://api.codepen.io
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

waitinteger

Seconds to wait for the build (default 45, at most 75; 0 answers as soon as the files are saved). A wait in the JSON body takes precedence.

Request body

access'Public' | 'Private' | 'Protected' | 'Collaborators'

Public; Private (not listed on the site; anyone with the link can view it); Protected (private and password protected); Collaborators (private and for collaborators only). Anything but Public needs a PRO plan.

descriptionstring
passwordstring

Required with Protected access, and refused with any other.

tagsstring[]
templateboolean
titlestring
waitinteger

Seconds to wait for the build (default 45, at most 75; 0 answers as soon as the files are saved).

Example request

{
  "files": [
    {
      "path": "index.html"
    }
  ]
}

Response

The new Pen, with build.

access'Public' | 'Private' | 'Protected' | 'Collaborators' required

Public; Private (not listed on the site; anyone with the link can view it); Protected (private and password protected); Collaborators (private and for collaborators only). Anything but Public needs a PRO plan.

created_atstring date-time required
descriptionstring required
editor'Classic' | 'V2' required

V2, or Classic for a Pen made in the classic editor, which is read-only through the API.

idstring required

The cpid, or the hashid for a Pen made in the classic editor.

loves_countinteger required
passwordstring nullable required

Write-only, so always null.

popularityinteger required
tagsstring[] required
templateboolean required
titlestring required
updated_atstring date-time required
views_countinteger required

Views as the site shows them, tallied in batches, so it can trail by a few minutes.

Example response

{
  "build": {
    "files": [
      {
        "name": "app.js",
        "path": "/src/app.js"
      }
    ]
  },
  "saved_version": {
    "build": {
      "files": [
        {
          "name": "app.js",
          "path": "/src/app.js"
        }
      ]
    },
    "files": [
      {
        "name": "app.js",
        "path": "/src/app.js"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.