# Documentation - [Nimply API](/docs): Schedule, publish, and measure social media content programmatically. - [Quickstart](/docs/quickstart): Create and schedule your first post with curl. - [Authentication](/docs/authentication): Authenticate with workspace-scoped API keys and understand scopes. - [Data model](/docs/data-model): Workspaces, channels, posts, and media — the mental model in five minutes. - [MCP Server](/docs/mcp): Connect Claude, Cursor, and other AI agents to Nimply - Integrations - [Integrations](/docs/integrations): Connect Nimply to your AI assistant, editor, or automation platform - **AI assistants** - [claude.ai](/docs/integrations/claude-ai): Connect Nimply to claude.ai with one click — no API key needed - [Claude Desktop](/docs/integrations/claude-desktop): Connect Nimply to the Claude Desktop app via OAuth or an API key - [ChatGPT](/docs/integrations/chatgpt): Connect Nimply to ChatGPT as a custom connector - [Grok](/docs/integrations/grok): Use Nimply from xAI's Grok via a custom MCP connector - [Perplexity](/docs/integrations/perplexity): Connect Nimply to Perplexity's desktop app or Comet - **IDEs & CLIs** - [Claude Code](/docs/integrations/claude-code): Add Nimply to Claude Code with one command - [Cursor](/docs/integrations/cursor): Add Nimply to Cursor via mcp.json - [VS Code](/docs/integrations/vs-code): Use Nimply with GitHub Copilot's agent mode in VS Code - [Windsurf](/docs/integrations/windsurf): Add Nimply to Windsurf's Cascade agent - [Codex CLI](/docs/integrations/codex-cli): Use Nimply from OpenAI's Codex CLI via the mcp-remote bridge - [Gemini CLI](/docs/integrations/gemini-cli): Add Nimply to Google's Gemini CLI - [OpenClaw](/docs/integrations/openclaw): Use Nimply from OpenClaw, the open-source self-hosted personal AI agent - [Raycast](/docs/integrations/raycast): Use Nimply from Raycast AI - [Any MCP client](/docs/integrations/any-mcp-client): The generic recipe — remote Streamable HTTP, OAuth or API-key header - **No-code** - [Zapier](/docs/integrations/zapier): Trigger Zaps on Nimply events and create posts from 6,000+ apps - [Make](/docs/integrations/make): Build Make scenarios with Nimply modules and instant triggers - [n8n](/docs/integrations/n8n): Automate Nimply from n8n — with the community node or plain HTTP nodes - **Workspace** - [Browser extension](/docs/integrations/browser-extension): Nimply Sidekick — save the post you are reading into your workspace and draft in your brand voice - [Slack](/docs/integrations/slack): Publish alerts and post approvals in your team's Slack workspace - [Telegram](/docs/integrations/telegram): Alerts, one-tap approvals, and an interactive bot in Telegram - [Telegram channels & groups](/docs/integrations/telegram-channels): Post to Telegram channels and groups, manage comments and personal DMs, run agents — by adding the Nimply bot as an admin - [WhatsApp Business](/docs/integrations/whatsapp): Answer WhatsApp Business chats from the unified inbox and let agents reply — connected through Meta's Embedded Signup, inbox only - [Canva](/docs/integrations/canva): Import your Canva designs into the media library, and round-trip edits - [Media imports](/docs/integrations/media-imports): Google Drive, OneDrive, Dropbox, Google Photos, and Unsplash in the media library - [Webhooks](/docs/webhooks): Get notified when posts publish, fail, or change - [Link pages](/docs/link-pages): Read and update your nimply.link bio pages — blocks, publishing, and analytics. - [Designs](/docs/designs): Create editable designs from a prompt, or turn any image into editable layers — from the API, ChatGPT, Claude, or any MCP client. - [Set up a brand kit and teach it your look](/docs/brand-kits): Create a brand kit, fill it from your website, a PDF brand book, text, a channel or images, and teach it how your designs look — from the API, ChatGPT, Claude or any MCP client. - [Agents](/docs/agents): Manage your AI agents from your app, ChatGPT or Claude — hire, change, pause, run, and approve what they make. - [Automations](/docs/automations): Build automations from your app, ChatGPT or Claude — start from a recipe or a list of steps, test, then switch on. - Examples - [Examples](/docs/examples): Copy-paste recipes for common Nimply API tasks. - [Schedule an image post](/docs/examples/schedule-image-post): Upload an image by URL and schedule it for a specific time. - [Upload a file as raw bytes](/docs/examples/upload-binary-file): Direct binary upload with a presigned URL — for local files and large videos - [Post to all channels in the next slot](/docs/examples/post-to-all-channels-next-slot): Fan a post out to every healthy channel's next free posting-schedule slot. - [Create a Reel](/docs/examples/create-a-reel): Upload a video by URL and publish it as short-form vertical video. - [Carousel post](/docs/examples/carousel-post): Attach multiple images to one post in a fixed display order. - [Upload a YouTube video](/docs/examples/upload-a-youtube-video): Publish a video with full YouTube options — category, visibility, license, and more. - [Pin to a Pinterest board](/docs/examples/pin-to-a-pinterest-board): List a channel's boards, then create a pin with a destination link and alt text. - [Post to LinkedIn](/docs/examples/post-to-linkedin): Publish a text, image, or video post to LinkedIn with visibility control. - [Post to TikTok](/docs/examples/post-to-tiktok): Check the account's creator info, then publish a video or photo post with privacy and interaction settings. - [Bulk-create posts from a CSV](/docs/examples/bulk-from-csv): Turn a content calendar spreadsheet into up to 50 posts in one request. - [Poll until published](/docs/examples/poll-until-published): Publish a post now, then poll until it's PUBLISHED or FAILED. - [Webhook receiver](/docs/examples/webhook-receiver): A minimal Express server that verifies Nimply webhook signatures. - [Client approval flow](/docs/examples/client-approval-flow): Send drafts for review, list pending posts, and approve or reject with a comment. - [Add a link to your page when a video goes live](/docs/examples/add-link-when-video-goes-live): Put every new YouTube upload at the top of your nimply.link page automatically — with the API, Zapier, or n8n. - [Errors](/docs/errors): Problem details responses, status codes, and rate limiting. - API Reference - [API Reference](/docs/api-reference): Every Nimply API endpoint, with parameters, schemas, and code samples. - Workspace - [Get the current workspace](/docs/api-reference/workspace/getWorkspace) - Channels - [Get a channel](/docs/api-reference/channels/getChannel) - [Get a channel's posting schedule](/docs/api-reference/channels/getChannelSchedule) - [List a Pinterest channel's boards](/docs/api-reference/channels/getPinterestBoards) - [Get a TikTok channel's creator info](/docs/api-reference/channels/getTikTokCreatorInfo) - [List connected channels](/docs/api-reference/channels/listChannels) - Posts - [Approve a post](/docs/api-reference/posts/approvePost) - [Post to LinkedIn](/docs/api-reference/posts/createLinkedInPost) - [Create a Pinterest pin](/docs/api-reference/posts/createPinterestPin) - [Create a post](/docs/api-reference/posts/createPost) - [Create posts in bulk](/docs/api-reference/posts/createPostsBulk) - [Post to TikTok](/docs/api-reference/posts/createTikTokPost) - [Post a YouTube video](/docs/api-reference/posts/createYouTubeVideo) - [Delete a post](/docs/api-reference/posts/deletePost) - [Get a post](/docs/api-reference/posts/getPost) - [List posts](/docs/api-reference/posts/listPosts) - [Publish a post now](/docs/api-reference/posts/publishPost) - [Reject a post](/docs/api-reference/posts/rejectPost) - [Request approval for a post](/docs/api-reference/posts/requestPostApproval) - [Schedule a post](/docs/api-reference/posts/schedulePost) - [Unschedule a post](/docs/api-reference/posts/unschedulePost) - [Update a post](/docs/api-reference/posts/updatePost) - Media - [Complete a direct binary upload](/docs/api-reference/media/completeMediaUpload) - [Start a direct binary upload](/docs/api-reference/media/createMediaUpload) - [Delete a media asset](/docs/api-reference/media/deleteMedia) - [Get a media asset](/docs/api-reference/media/getMedia) - [List media assets](/docs/api-reference/media/listMedia) - [Import media from a URL](/docs/api-reference/media/uploadMedia) - Agent runs - [Cancel an agent run](/docs/api-reference/agent-runs/cancelAgentRun) - [Get an agent run](/docs/api-reference/agent-runs/getAgentRun) - Agent templates - [Get an agent template](/docs/api-reference/agent-templates/getAgentTemplate) - [List agent templates](/docs/api-reference/agent-templates/listAgentTemplates) - Agents - [Get an agent](/docs/api-reference/agents/getAgent) - [Hire an agent](/docs/api-reference/agents/hireAgent) - [List an agent's recent runs](/docs/api-reference/agents/listAgentRuns) - [List agents](/docs/api-reference/agents/listAgents) - [Remove an agent](/docs/api-reference/agents/removeAgent) - [Run an agent now](/docs/api-reference/agents/runAgent) - [Change an agent](/docs/api-reference/agents/updateAgent) - Analytics - [Channel analytics](/docs/api-reference/analytics/getChannelAnalytics) - [Post analytics](/docs/api-reference/analytics/getPostAnalytics) - [Workspace analytics summary](/docs/api-reference/analytics/getWorkspaceAnalytics) - Automation recipes - [List automation recipes](/docs/api-reference/automation-recipes/listAutomationRecipes) - Automation runs - [Get an automation run](/docs/api-reference/automation-runs/getAutomationRun) - Automation step types - [List automation step types](/docs/api-reference/automation-step-types/listAutomationStepTypes) - Automations - [Switch an automation on](/docs/api-reference/automations/activateAutomation) - [Create an automation](/docs/api-reference/automations/createAutomation) - [Create an automation from a recipe](/docs/api-reference/automations/createAutomationFromRecipe) - [Delete an automation](/docs/api-reference/automations/deleteAutomation) - [Get an automation](/docs/api-reference/automations/getAutomation) - [List runs of an automation](/docs/api-reference/automations/listAutomationRuns) - [List automations](/docs/api-reference/automations/listAutomations) - [Pause an automation](/docs/api-reference/automations/pauseAutomation) - [Run an automation now](/docs/api-reference/automations/runAutomation) - [Test an automation](/docs/api-reference/automations/testAutomation) - [Update an automation](/docs/api-reference/automations/updateAutomation) - Brand kits - [Add examples to learn the look from](/docs/api-reference/brand-kits/addBrandKitStyleExamples) - [Create a brand kit](/docs/api-reference/brand-kits/createBrandKit) - [Create a brand kit from several sources](/docs/api-reference/brand-kits/createBrandKitImport) - [Price a brand import](/docs/api-reference/brand-kits/estimateBrandKitImport) - [Get a brand kit](/docs/api-reference/brand-kits/getBrandKit) - [Get a brand import](/docs/api-reference/brand-kits/getBrandKitImport) - [Get a brand kit's learned look](/docs/api-reference/brand-kits/getBrandKitStyle) - [Read a brand from its website](/docs/api-reference/brand-kits/importBrandKit) - [Learn the look from the examples](/docs/api-reference/brand-kits/learnBrandKitStyle) - [List brand kits](/docs/api-reference/brand-kits/listBrandKits) - [List published posts to learn from](/docs/api-reference/brand-kits/listBrandKitStylePostCandidates) - [Remove an example](/docs/api-reference/brand-kits/removeBrandKitStyleExample) - [Save a brand import as a brand kit](/docs/api-reference/brand-kits/saveBrandKitImport) - [Set the look's rules](/docs/api-reference/brand-kits/setBrandKitStyleRules) - [Update a brand kit](/docs/api-reference/brand-kits/updateBrandKit) - Design jobs - [Cancel a design job](/docs/api-reference/design-jobs/cancelDesignJob) - [Get a design job](/docs/api-reference/design-jobs/getDesignJob) - Design sizes - [List design sizes](/docs/api-reference/design-sizes/listDesignSizes) - Designs - [Turn an image into an editable, layered design](/docs/api-reference/designs/createDesignFromImage) - [Estimate the credits a design run can use](/docs/api-reference/designs/estimateDesignCost) - [Create a design from a prompt](/docs/api-reference/designs/generateDesign) - [Get a design](/docs/api-reference/designs/getDesign) - [List designs](/docs/api-reference/designs/listDesigns) - Link pages - [Add a block to a link page](/docs/api-reference/link-pages/createLinkPageBlock) - [Delete a block](/docs/api-reference/link-pages/deleteLinkPageBlock) - [Get a link page with its blocks](/docs/api-reference/link-pages/getLinkPage) - [Link page analytics](/docs/api-reference/link-pages/getLinkPageAnalytics) - [List the blocks of a link page](/docs/api-reference/link-pages/listLinkPageBlocks) - [List link pages](/docs/api-reference/link-pages/listLinkPages) - [Publish a link page](/docs/api-reference/link-pages/publishLinkPage) - [Update a link page (title, bio, SEO)](/docs/api-reference/link-pages/updateLinkPage) - [Update a block](/docs/api-reference/link-pages/updateLinkPageBlock) - Webhooks - [Create a webhook](/docs/api-reference/webhooks/createWebhook) - [Delete a webhook](/docs/api-reference/webhooks/deleteWebhook) - [Get a webhook](/docs/api-reference/webhooks/getWebhook) - [List webhooks](/docs/api-reference/webhooks/listWebhooks) - [Send a test event](/docs/api-reference/webhooks/testWebhook) - [Update a webhook](/docs/api-reference/webhooks/updateWebhook) - [Roadmap](/docs/roadmap): What's shipped, what's in progress, and what we're exploring.