# Ur Next Door API > UrNextDoor - Where you Blog, Connect, Learn, Hire & Grow together. The Ur Next Door API lets a member of https://urnextdoor.com create and schedule Posts, Questions, Polls, MCQs, Communities, Marketplace Services and Jobs, and upload images, from a script, an automation tool or an AI agent. Each member creates personal API keys in Settings > API keys on the website or in the app. A request acts as that member, with the same permissions they have on the website. - Base URL: https://urnextdoor.com/api/v1 (apex domain only) - Auth: `Authorization: Bearer und_sk_...` or `X-API-Key: und_sk_...` (never in a URL) - Bodies: JSON; content bodies are HTML. Times: ISO 8601, scheduling stores UTC. - OpenAPI 3.1: https://urnextdoor.com/api/v1/openapi.json ## Overview - [Ur Next Door API Docs](https://docs.urnextdoor.com/index.md): Create and schedule posts, questions, polls, MCQs, communities, services and jobs on Ur Next Door from scripts, automation tools and AI agents. ## Get started - [Get started with the Ur Next Door API](https://docs.urnextdoor.com/getting-started.md): The ideas behind the Ur Next Door API: personal keys, scopes, HTML bodies, publishing now or later, quotas, and safe retries. Start here. - [Create an API key](https://docs.urnextdoor.com/getting-started/create-api-key.md): Step by step: create an Ur Next Door API key in Settings > API keys on the website or in the app, copy it once, and store it in UND_API_KEY. - [Authentication](https://docs.urnextdoor.com/getting-started/authentication.md): Send your Ur Next Door API key as a Bearer token or an X-API-Key header, on the apex domain only. What a key can do, and the 401 and 421 errors. - [Scopes and permissions](https://docs.urnextdoor.com/getting-started/scopes.md): The four API key scopes (content, media, schedule, read), which endpoints each one unlocks, and which combination to give each kind of tool. - [Make your first request](https://docs.urnextdoor.com/getting-started/first-request.md): Check your Ur Next Door API key with GET /me, publish your first post, open it on the site, and read your remaining daily quota. About five minutes. ## Guides - [Guides](https://docs.urnextdoor.com/guides.md): Step by step guides for creating every kind of Ur Next Door content with the API, uploading images, formatting bodies, and scheduling posts. - [Create a post](https://docs.urnextdoor.com/guides/create-post.md): Publish an Ur Next Door post with the API: title, HTML body, tags, a featured image, a community, and an optional schedule, with examples in four languages. - [Ask a question](https://docs.urnextdoor.com/guides/create-question.md): Post a question on Ur Next Door with the API. Only a title is required; add HTML details, tags, images, a community or a schedule when you need them. - [Create a poll](https://docs.urnextdoor.com/guides/create-poll.md): Create an Ur Next Door poll with the API: a question and 2 to 5 unique options, with optional details, tags, image, community and schedule. - [Create an MCQ](https://docs.urnextdoor.com/guides/create-mcq.md): Create a multiple choice quiz question on Ur Next Door with the API: 2 to 5 options and a 0-based correct_option_index, now or on a schedule. - [Create a community](https://docs.urnextdoor.com/guides/create-community.md): Create an Ur Next Door community with the API: a unique name, HTML description, visibility and icon. Create it now (201) or schedule it (202). - [List a service in the Marketplace](https://docs.urnextdoor.com/guides/create-service.md): List an Ur Next Door Marketplace service with the API: category lookup, service mode, location rules, up to 3 packages priced in rupees, and FAQs. - [Post a job](https://docs.urnextdoor.com/guides/create-job.md): Post a job on Ur Next Door with the API: employment type, work mode, experience level, salary range and currency, deadline and location rules. - [Upload images, including AI generated ones](https://docs.urnextdoor.com/guides/upload-images.md): Upload an image to Ur Next Door as base64 JSON or a multipart file, then use data.url as a featured image or in a gallery. Limits and AI image tips. - [Format content with HTML](https://docs.urnextdoor.com/guides/formatting.md): Which HTML tags and attributes Ur Next Door keeps in API content bodies, what it removes, how hashtags and mentions work, and how to convert Markdown. - [Schedule content](https://docs.urnextdoor.com/guides/schedule-content.md): Publish Ur Next Door content later with scheduled_at: ISO 8601 in UTC, 5 minutes to 180 days ahead, time zone conversion, quotas and what happens next. - [Manage scheduled content](https://docs.urnextdoor.com/guides/manage-scheduled.md): List your scheduled Ur Next Door items, move them to a new time, publish them now, or cancel them, with the schedule scope of the API. - [Look up ids for communities, categories, jobs and places](https://docs.urnextdoor.com/guides/lookups.md): Use the read scope lookups to get community ids, service category ids, job option values, places and community icons instead of guessing them. ## Use with AI - [Use the API with AI tools](https://docs.urnextdoor.com/ai.md): Connect your Ur Next Door API key to Claude Code, Codex CLI or a ChatGPT custom GPT, and what Claude Desktop needs. Safety rules for agents that post as you. - [Use the API from Claude Code](https://docs.urnextdoor.com/ai/claude-code.md): Let Claude Code publish to Ur Next Door: put your key in UND_API_KEY, add a CLAUDE.md note that points at the docs, allow curl, and start with a test prompt. - [Use the API from Codex CLI](https://docs.urnextdoor.com/ai/codex-cli.md): Let OpenAI Codex CLI publish to Ur Next Door: set UND_API_KEY, turn on network access in the sandbox, add an AGENTS.md note, and test with GET /me. - [Use the API from a ChatGPT custom GPT](https://docs.urnextdoor.com/ai/chatgpt-actions.md): Build a private custom GPT that posts to Ur Next Door: import the OpenAPI URL as an Action, set Bearer API key auth, keep it Only me, and mind the image limits. - [Claude Desktop and claude.ai](https://docs.urnextdoor.com/ai/claude-desktop.md): Why Claude Desktop chat and claude.ai cannot call the Ur Next Door API yet, the official MCP server on the roadmap, and how to use Claude Code meanwhile. - [System prompt for AI agents](https://docs.urnextdoor.com/ai/system-prompt.md): A copy-paste system prompt that makes any AI agent use the Ur Next Door API safely: key handling, confirmation, images, lookups, idempotency and errors. - [Prompt recipes for AI agents](https://docs.urnextdoor.com/ai/prompt-recipes.md): Ready prompts for AI agents using the Ur Next Door API: publish a post, schedule a week, use a generated image, run a quiz series, list a service, post a job. ## Integrations - [Integrations](https://docs.urnextdoor.com/integrations.md): Use the Ur Next Door API from Postman, n8n, Zapier or plain cURL: ready collections, credential setup, and step by step automations without writing code. - [Use the API with Postman](https://docs.urnextdoor.com/integrations/postman.md): Import the Ur Next Door Postman collection and environment, store your API key as a secret variable, and send every API request from Postman. - [Use the API with n8n](https://docs.urnextdoor.com/integrations/n8n.md): Publish to Ur Next Door from n8n: a Header Auth credential for your key, the HTTP Request node for creates and uploads, and a schedule trigger. - [Use the API with Zapier](https://docs.urnextdoor.com/integrations/zapier.md): Publish to Ur Next Door from a Zap with Webhooks by Zapier: header setup for your API key, a JSON body, and a spreadsheet row to scheduled post example. - [Use the API with cURL](https://docs.urnextdoor.com/integrations/curl.md): Call the Ur Next Door API from the command line with cURL: a reusable shell helper, JSON bodies from files, reading headers, jq, and Windows notes. ## API reference - [API reference](https://docs.urnextdoor.com/reference.md): Ur Next Door API v1 reference: base URL, authentication, request and response envelopes, headers, and every endpoint grouped by area. - [Account endpoints](https://docs.urnextdoor.com/reference/account.md): Check which member and key a request runs as, see today's quota usage, and fetch the OpenAPI document. - [Content endpoints](https://docs.urnextdoor.com/reference/content.md): Create posts, questions, polls, MCQs, communities, Marketplace services and jobs, now or at a scheduled time. - [Media endpoint](https://docs.urnextdoor.com/reference/media.md): Upload an image as base64 JSON or multipart, then use the returned URL as a featured image or in a gallery. - [Scheduling endpoints](https://docs.urnextdoor.com/reference/scheduling.md): List your scheduled items, move them to a new time, publish them now, or cancel them before they go live. - [Lookup endpoints](https://docs.urnextdoor.com/reference/lookups.md): Find the ids the create endpoints need: communities you can post in, service categories, job options, places and icons. - [OpenAPI specification](https://docs.urnextdoor.com/reference/openapi.md): Download or import the Ur Next Door API OpenAPI 3.1 document for ChatGPT Actions, Postman, code generators and AI agents, plus the extensions it uses. ## Platform - [Rate limits and daily quotas](https://docs.urnextdoor.com/limits.md): Ur Next Door API daily quotas per plan and action, the 60 requests a minute limit, rate limit headers, UTC midnight resets, and size limits. - [Errors](https://docs.urnextdoor.com/errors.md): Every Ur Next Door API error code, its HTTP status, what causes it and what to do, plus how to read validation errors and which requests are safe to retry. - [Idempotency](https://docs.urnextdoor.com/idempotency.md): Make Ur Next Door API retries safe with the Idempotency-Key header: key format, 24 hour replay, conflicts, and code to generate keys in four languages. - [Keep your API key safe](https://docs.urnextdoor.com/security.md): Store Ur Next Door API keys in environment variables, never in browser code or shared GPTs, use narrow scopes and expiry, rotate them, and revoke a leaked key. - [API analytics](https://docs.urnextdoor.com/analytics.md): See what your Ur Next Door API keys did in Settings > Analytics: manual versus API activity, per key, by event and type, the event log, and CSV export. ## Rules for AI agents - Read the key from the UND_API_KEY environment variable. Never print, log or echo it, and never put it in a URL. - Confirm with the member before you publish public content, unless they asked you to publish without asking. - Upload images first with POST /api/v1/media, then pass the returned data.url as featured_image or in gallery. - Get ids from the lookup endpoints (communities, service categories, job options, geo, community icons). Never invent an id. - Send a new Idempotency-Key (a UUID) on every create, and reuse it only when retrying that same request. - Schedule with scheduled_at in UTC ending in Z, between 5 minutes and 180 days ahead. - On 422 read the errors object, fix the named fields and retry. On 429 wait for Retry-After seconds and report the remaining quota. - When you finish, give the member the web_url of what you created. ## Citation guidance - Cite these pages by their canonical URL on https://docs.urnextdoor.com; the .md links above are clean copies of the same pages. - The API itself is the source of truth. If a page and https://urnextdoor.com/api/v1/openapi.json disagree, trust the OpenAPI document. - Quotas and limits can change; quote them with the date of the page they came from. ## Optional - [Changelog](https://docs.urnextdoor.com/changelog.md): Changes to the Ur Next Door API and these docs, newest first. Subscribe to the Atom feed to hear about new endpoints, fields and limits. - [Frequently asked questions](https://docs.urnextdoor.com/faq.md): Answers to common questions about the Ur Next Door API: keys, pricing and quotas, AI tools, images, scheduling, communities, errors and what is coming next. - [Full docs in one file](https://docs.urnextdoor.com/llms-full.txt): Every page above as Markdown, in one file. - [OpenAPI document](https://urnextdoor.com/api/v1/openapi.json): The machine readable contract (a copy is at https://docs.urnextdoor.com/openapi.json). - [Agent system prompt](https://docs.urnextdoor.com/ai/system-prompt.txt): A copy-paste prompt for agents that use the API. - [Postman collection](https://docs.urnextdoor.com/downloads/urnextdoor-api.postman_collection.json): One request per endpoint. - [Sitemap](https://docs.urnextdoor.com/sitemap.xml): Every indexable docs URL.