Create a Page

Create a new page to organize pins in a structured document.

Endpoint


POST /v1/pages

Authentication

Requires API key with pages:write scope.


Authorization: Bearer pk_live_your_api_key

Request Body

Field	Type	Required	Description
`metadata`	object	Yes	Page metadata including title
`pins`	string[]	No	Array of pin IDs to add initially (default: `[]`)
`is_public`	boolean	No	Public visibility (default: `false`)

Metadata Object

Field	Type	Required	Description
`title`	string	Yes	Page title
`tags`	string[]	No	Tags for organization

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
// Create page
const page = await client.pages.create({
  metadata: {
    title: 'Monthly Sales Report',
    tags: ['sales', 'monthly', 'report']
  }
})
 
console.log(`Page created: ${page.id}`)

cURL


curl -X POST https://api.pindown.ai/v1/pages \
  -H "Authorization: Bearer pk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "title": "Monthly Sales Report",
      "tags": ["sales", "monthly", "report"]
    }
  }'

Node.js Fetch


const response = await fetch('https://api.pindown.ai/v1/pages', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    metadata: {
      title: 'Monthly Sales Report',
      tags: ['sales', 'monthly', 'report']
    }
  })
})
 
const result = await response.json()
console.log(`Page created: ${result.data.id}`)

Response


{
  "success": true,
  "data": {
    "id": "pg-abc123xyz",
    "title": "Monthly Sales Report",
    "created_at": 1703123456789
  },
  "message": "Page created successfully"
}

Next Steps

Get Page - Retrieve page details
Add Pin to Page - Add pins to your page
List Pages - List all your pages