Pinterest API

Schedule and automate Pinterest pins with RelayAPI — image pins, video pins, board targeting, destination links, and SEO optimization.

Quick Reference

Property	Value
Platform key	`pinterest`
Auth method	OAuth 2.0
Title limit	100 characters
Description limit	800 characters
Images per pin	1, or 2–5 in a carousel
Videos per pin	1
Image formats	JPEG, PNG
Image max size	20 MiB
Video formats	MP4, MOV
Video max size	2 GB
Video duration	4 sec - 15 min
Post types	Image Pin, Video Pin
Scheduling	Yes
Analytics	Limited (impressions, saves, clicks)

Client options — TypeScript · Python REST/OpenAPI · Go · Java · REST API

Pinterest is a search engine, not a social feed. Pins are discovered through search and browse, not by followers. SEO (title, description, board name) matters more than posting time. Pins have a 3-6 month lifespan unlike hours on other platforms. The board_id field is effectively required — always provide it. Media is required for all pins; there are no text-only posts. RelayAPI accepts a single image, a 2–5 image carousel, or one video with one optional cover image.

Quick Start

Create a pin on Pinterest:

import Relay from '@relayapi/sdk';

const client = new Relay();
const post = await client.posts.create({
  content: 'Modern kitchen renovation ideas for small spaces',
  targets: ['pinterest'],
  media: [
    { url: 'https://cdn.example.com/kitchen.jpg', type: 'image' },
  ],
  scheduled_at: 'now',
  target_options: {
    pinterest: {
      title: 'Modern Kitchen Renovation Ideas',
      board_id: 'YOUR_BOARD_ID',
      link: 'https://myblog.com/kitchen-renovation',
    },
  },
});

console.log(post.id); // post_abc123

Content Types

Image Pin

Use 2:3 aspect ratio (1000 x 1500 px) for optimal feed display. The link field is critical for driving traffic to your website.

const post = await client.posts.create({
  content: 'Modern kitchen renovation ideas for small spaces',
  targets: ['pinterest'],
  media: [
    { url: 'https://cdn.example.com/kitchen.jpg', type: 'image' },
  ],
  scheduled_at: 'now',
  target_options: {
    pinterest: {
      title: 'Modern Kitchen Renovation Ideas',
      board_id: 'YOUR_BOARD_ID',
      link: 'https://myblog.com/kitchen-renovation',
    },
  },
});

Video Pin

Single video per pin. Supports a custom cover image.

const post = await client.posts.create({
  content: 'Quick 5-minute breakfast recipe',
  targets: ['pinterest'],
  media: [
    { url: 'https://cdn.example.com/recipe.mp4', type: 'video' },
  ],
  scheduled_at: 'now',
  target_options: {
    pinterest: {
      title: '5-Minute Breakfast Recipe',
      board_id: 'YOUR_BOARD_ID',
      link: 'https://myrecipes.com/quick-breakfast',
      cover_image_url: 'https://cdn.example.com/recipe-cover.jpg',
    },
  },
});

Video Pin with Auto-Generated Cover

Instead of providing a cover image, extract a frame from the video at a specific timestamp.

const post = await client.posts.create({
  content: 'DIY home project walkthrough',
  targets: ['pinterest'],
  media: [
    { url: 'https://cdn.example.com/diy.mp4', type: 'video' },
  ],
  scheduled_at: 'now',
  target_options: {
    pinterest: {
      title: 'DIY Bookshelf Build',
      board_id: 'YOUR_BOARD_ID',
      link: 'https://myblog.com/diy-bookshelf',
      cover_image_key_frame_time: 5,
    },
  },
});

The link field is critical on Pinterest. It determines where users go when they click the pin. Without it, your pin cannot drive traffic.

Media Requirements

Images

Property	Requirement
Max per pin	5 (2–5 for a carousel)
Formats	JPEG, PNG
Max file size	20 MiB each
Recommended	1000 x 1500 px (2:3 portrait)
Min dimensions	100 x 100 px

Aspect Ratios

Type	Ratio	Notes
Portrait	2:3	Optimal for feed display
Square	1:1	Works well in feed
Long pin	1:2.1	Maximum vertical ratio

Videos

Property	Requirement
Max per pin	1
Formats	MP4, MOV
Max file size	2 GB
Duration	4 sec - 15 min
Aspect ratio	2:3, 1:1, or 9:16
Recommended	1080p, 25+ fps

`target_options` Fields

All fields go inside target_options.pinterest on your post request.

Field	Type	Description
`content`	string	Override description for Pinterest specifically
`media`	object[]	Override media for Pinterest specifically
`title`	string	Pin title (max 100 chars). Falls back to first line of content.
`board_id`	string	Target board ID. Effectively required for all pins.
`link`	string	Destination URL when users click the pin. Critical for driving traffic.
`cover_image_url`	string	Custom cover image URL for video pins
`cover_image_key_frame_time`	number	Auto-extract a video frame at N seconds for the cover

Common Errors

Error	Cause	Fix
Invalid URL or request data	Media URL is inaccessible or returns non-media content	Verify the URL is a publicly accessible HTTPS link returning actual media bytes.
Unable to reach URL	Pinterest servers cannot fetch the media	Test the URL in an incognito browser window. If you see a webpage instead of media, it will not work.
Rate limit reached	Too many API calls in a short window	Space out pin creation. Avoid bursts of 10+ pins.
Requires boardId	No board was specified	Always provide the `board_id` field.

Known Quirks

Search engine, not social feed — SEO (title, description, board name) matters more than posting time.
Pins have a 3-6 month lifespan — unlike hours on Twitter or Instagram, pins continue driving traffic for months.
board_id is effectively required — always specify which board to pin to.
link field is critical for driving traffic. Without it, users cannot click through to your content.
No text-only pins — media is required for every pin.
Image carousels contain 2–5 images — a single image remains a normal image Pin.
Generic gif attachments are rejected — RelayAPI's Pinterest publisher accepts JPEG/PNG images and MP4/MOV video, not the channel-neutral GIF media type.
2:3 aspect ratio (1000 x 1500 px) gets the best feed placement and engagement.

Automations

Pinterest is destination-only in the automations engine — no inbound triggers today.

Send nodes

Node	Endpoint	Required fields
`pinterest_create_pin`	`POST https://api.pinterest.com/v5/pins`	`board_id`, `image_url`, `title`, optional `description` / `link`

Found something wrong? Help us improve this page.

Report an issue Edit this page on GitHub