# The Prompting Company

- [Quickstart guide](https://docs.promptingcompany.com/guides/quickstart-guide.md): The fastest way to get started with The Prompting Company
- [Knowledge base](https://docs.promptingcompany.com/guides/knowledge-base.md): Understand how your product's facts and guidance improve prompts, content, and factual accuracy
- [Add prompts](https://docs.promptingcompany.com/guides/add-prompts.md): Add and manage prompts to track if your product gets mentioned in AI responses
- [Create content](https://docs.promptingcompany.com/guides/create-content.md): Generate blog posts from your tracked prompts to educate AI about your business
- [Metrics](https://docs.promptingcompany.com/guides/metrics.md): Understand share of voice, industry rankings, AI traffic, and content analytics
- [CMS integrations](https://docs.promptingcompany.com/guides/cms/overview.md): Connect The Prompting Company to your CMS to publish generated content as drafts
- [Connect WordPress](https://docs.promptingcompany.com/guides/cms/wordpress.md): Publish TPC drafts to WordPress using the TPC connector plugin
- [Connect Sanity](https://docs.promptingcompany.com/guides/cms/sanity.md): Publish TPC drafts to Sanity using a project-scoped API token
- [Connect Webflow](https://docs.promptingcompany.com/guides/cms/webflow.md): Publish TPC drafts to a Webflow CMS collection using a site API token
- [Connect Ghost](https://docs.promptingcompany.com/guides/cms/ghost.md): Publish TPC drafts to Ghost using a Custom Integration Admin API key
- [Connect Framer](https://docs.promptingcompany.com/guides/cms/framer.md): Publish TPC drafts to a Framer CMS collection using a Framer API key
- [Connect Prismic](https://docs.promptingcompany.com/guides/cms/prismic.md): Publish TPC drafts to a Prismic repository using a permanent access token
- [Connect a custom endpoint](https://docs.promptingcompany.com/guides/cms/custom.md): Publish TPC drafts to your own server via a JSON POST endpoint with bearer authentication
- [Integration with Cloudflare](https://docs.promptingcompany.com/guides/analytics/cf-integration.md): Track page visits at the edge by deploying a Cloudflare Worker that forwards page_visit events to The Prompting Company
- [Cloudflare Logpush](https://docs.promptingcompany.com/guides/analytics/log-exporters/cloudflare-logpush.md): Stream HTTP request logs from Cloudflare to The Prompting Company and watch AI crawler traffic in your dashboards
- [Raw events API](https://docs.promptingcompany.com/guides/analytics/log-exporters/raw-events.md): Send crawler logs to The Prompting Company from any log source — nginx, CDNs, or a backfill script
- [Export AI crawler traffic from Cloudflare](https://docs.promptingcompany.com/guides/analytics/cf-traffic-export.md): Pull AI agent and crawler traffic for your Cloudflare-proxied domain into a CSV to share with The Prompting Company
- [Overview](https://docs.promptingcompany.com/guides/coding-agent-optimization/overview.md): Evaluate and optimize how coding agents experience your product in sandboxed environments
- [Tasks](https://docs.promptingcompany.com/guides/coding-agent-optimization/tasks.md): Define what agents should accomplish and how success is measured
- [Environments](https://docs.promptingcompany.com/guides/coding-agent-optimization/environments.md): Configure which agents attempt your tasks and the sandboxes they run in
- [Runs & iterations](https://docs.promptingcompany.com/guides/coding-agent-optimization/runs.md): What happens during a single agent attempt, what it records, and how runs batch into iterations
- [Experiments](https://docs.promptingcompany.com/guides/coding-agent-optimization/experiments.md): Run tasks across environments in parallel and read the results
- [Signals](https://docs.promptingcompany.com/guides/coding-agent-optimization/signals.md): Extract custom metrics from runs with a YAML signal config
- [Limits & constraints](https://docs.promptingcompany.com/guides/coding-agent-optimization/limits.md): How the sandbox executes a run, and the hard limits that shape how you write tasks
- [CLI overview](https://docs.promptingcompany.com/cli/overview.md): Terminal access to your workspace, organizations, and simulation workflows.
- [Installation](https://docs.promptingcompany.com/cli/installation.md): Install, update, and pin versions of the TPC CLI on macOS, Linux, and Windows.
- [Authentication](https://docs.promptingcompany.com/cli/authentication.md): Log in with device flow, or authenticate the TPC CLI non-interactively for CI.
- [Organizations](https://docs.promptingcompany.com/cli/organizations.md): List organizations and pass --scope on TPC CLI commands.
- [Content](https://docs.promptingcompany.com/cli/commands/content.md): Create, generate, review, publish, and manage content from the TPC CLI.
- [Knowledge](https://docs.promptingcompany.com/cli/commands/knowledge.md): List, read, and write generated knowledge files from the TPC CLI.
- [Prompts](https://docs.promptingcompany.com/cli/commands/prompts.md): List, create, and review prompts and prompt suggestions from the TPC CLI.
- [Playbooks](https://docs.promptingcompany.com/cli/commands/playbooks.md): Find playbook candidates, start and inspect runs, and configure automation for a product.
- [Views](https://docs.promptingcompany.com/cli/commands/views.md): List, create, and edit views and the prompts in them from the TPC CLI.
- [Personas](https://docs.promptingcompany.com/cli/commands/persona.md): List, create, update, and delete product personas from the TPC CLI.
- [llms.txt generation](https://docs.promptingcompany.com/cli/commands/llmstxt.md): Generate llms.txt files for any site from its sitemap with the TPC CLI.
- [Analytics](https://docs.promptingcompany.com/cli/commands/analytics.md): Read share of voice, sentiment, traffic, and citations from the TPC CLI, or build a custom query with explore.
- [Model council](https://docs.promptingcompany.com/cli/commands/council.md): Run Model Council snapshots, manage config.yaml, and read or delete results from the TPC CLI.
- [Model Council v2](https://docs.promptingcompany.com/cli/commands/council-v2.md): Create narrative questions, collect fresh answer batches, and retrieve narrative results with noninteractive commands.
- [Simulation environments](https://docs.promptingcompany.com/cli/commands/simulation-environments.md): Create and configure agent simulation environments from the TPC CLI.
- [Agent Experience](https://docs.promptingcompany.com/cli/commands/agent-experience.md): Set up AX experiments and competitive benchmarks, and answer onboarding questions from your terminal.
- [Competitive position across topics](https://docs.promptingcompany.com/cli/recipes/competitive-position-by-topic.md): Find your industry ranking in every tracked topic with the TPC CLI.
- [Troubleshooting](https://docs.promptingcompany.com/cli/troubleshooting.md): Fix common TPC CLI install, login, and update problems.
- [Connect the MCP server](https://docs.promptingcompany.com/mcp/connect.md): Add The Prompting Company MCP server to Claude Code, Claude.ai, or another MCP client and sign in with your TPC account.
- [How is my product doing in AEO?](https://docs.promptingcompany.com/mcp/check-aeo.md): Ask your agent how your product shows up in AI answers, and see which MCP tools it uses to answer.
- [Help me improve the AEO of my product](https://docs.promptingcompany.com/mcp/improve-aeo.md): Ask your agent to find where your product falls short in AI answers and make the changes you approve in TPC.
- [API overview](https://docs.promptingcompany.com/api/overview.md): Start using the TPC API, authentication methods, scopes, and reference docs.
- [Quickstart](https://docs.promptingcompany.com/api/quickstart.md): Make your first successful TPC API request with an API key.
- [Authentication](https://docs.promptingcompany.com/api/authentication.md): Choose between session cookies, OAuth bearer tokens, and API keys for the TPC API.
- [API reference](https://docs.promptingcompany.com/api/reference.md): OpenAPI-generated endpoint reference for the TPC API.
- [Scopes](https://docs.promptingcompany.com/api/scopes.md): Review the TPC API scope catalog and minimum-scope examples.
- [Rate limits](https://docs.promptingcompany.com/api/rate-limits.md): Understand TPC API quotas, retry headers, and 429 handling.
- [Idempotency](https://docs.promptingcompany.com/api/idempotency.md): Use Idempotency-Key for safe TPC API retries.
- [Errors](https://docs.promptingcompany.com/api/errors.md): Handle The Prompting Company API result envelopes, error codes, and request IDs.
- [Audit log](https://docs.promptingcompany.com/api/audit-log.md): Understand what TPC records for API write requests.
- [Content API overview](https://docs.promptingcompany.com/api/content/overview.md): Understand the TPC content API surfaces and common workflows.
- [Site pages migration](https://docs.promptingcompany.com/api/content/site-pages.md): Migrate deprecated TPC Site Pages API integrations to the content lifecycle API.
- [Content documents](https://docs.promptingcompany.com/api/content/documents.md): Use TPC document endpoints for generated content and draft workflows.
- [Verify production runtime capabilities](https://docs.promptingcompany.com/api/reference/service-status/verify-production-runtime-capabilities.md): Runs a fixed, local, read-only probe of the production runtime. It accepts no model, text, module, URL, or filesystem input and performs no paid or third-party operation.
- [Get share of voice accumulated over a date range](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/get-share-of-voice-accumulated-over-a-date-range.md)
- [Get rolling share of voice time series and breakdowns](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/get-rolling-share-of-voice-time-series-and-breakdowns.md)
- [Get per-prompt sentiment analytics for a product](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/get-per-prompt-sentiment-analytics-for-a-product.md)
- [Run a dimensional analytics query for a product](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/run-a-dimensional-analytics-query-for-a-product.md): Query one analytics metric (sov, citations, traffic, sentiment) grouped by at most one dimension, scoped by filters and a date window. Returns flat rows plus column metadata for generic rendering.
- [Ingest server-side SDK analytics event (page_visit)](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/ingest-server-side-sdk-analytics-event-page_visit.md)
- [List conversation queries](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/list-conversation-queries.md): Requires at least one of `brandId`, `promptId`, or `promptIds`. Use `viewId` with `brandId` to limit results to a view.
- [List views](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/list-views.md): Lists the organization's views, newest first, each with its brand and conversationCount. Filter by brandId; search matches name or description. page is one-based.
- [Create a view](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/create-a-view.md): Creates a view for a brand in the organization. Send conversationQueryIds, or promptIds to add each prompt's active conversation queries, not both. Ids that do not belong to the brand are skipped.
- [Get a view](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/get-a-view.md): Returns a view with its brand and conversations, including memberships whose conversation query was archived.
- [Update a view](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/update-a-view.md): Updates the supplied fields of a view. Setting isDefault to true clears the default flag on the brand's other views.
- [Add conversations to a view](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/add-conversations-to-a-view.md): Adds conversation queries of the view's brand to the view. Send conversationQueryIds, or promptIds to add each prompt's active conversation queries, not both. Ids outside the brand are skipped; the request fails with 400 when none are valid. Answers 200 with addedCount 0 when every valid id is alrea…
- [Remove conversations from a view](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/remove-conversations-from-a-view.md): Removes the listed conversation queries, or every conversation query of the listed promptIds, from the view, including ones whose conversation query was archived.
- [Summarize industry rankings across prompt topics](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/summarize-industry-rankings-across-prompt-topics.md): Returns each topic's competitive position and compact product ranking, aggregated from the existing prompt-level share-of-voice data. Pass status to filter to one competitive state (winning, contested, opportunity, or unranked) server-side. Pass page and/or pageSize (max 100) to page through topics;…
- [List prompt suggestions for a product](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/list-prompt-suggestions-for-a-product.md)
- [Update a prompt suggestion's message, persona, or answer engines](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/update-a-prompt-suggestions-message-persona-or-answer-engines.md)
- [Regenerate prompt suggestions for a product (fan-out by topic)](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/regenerate-prompt-suggestions-for-a-product-fan-out-by-topic.md)
- [Approve or reject prompt suggestions](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/approve-or-reject-prompt-suggestions.md): Batch-approve or reject prompt suggestions. Approval creates tracked prompts and conversation queries using each suggestion's persona and answer engines, falling back to the product default persona and chatgpt/gemini/sonar.
- [Update a prompt message and its query analytics](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/update-a-prompt-message-and-its-query-analytics.md)
- [Get cited-source analytics and citation events](https://docs.promptingcompany.com/api/reference/traffic-&-sources/get-cited-source-analytics-and-citation-events.md)
- [List products (brands) in the active organization](https://docs.promptingcompany.com/api/reference/products/list-products-brands-in-the-active-organization.md)
- [Create a product (brand) in the active organization](https://docs.promptingcompany.com/api/reference/products/create-a-product-brand-in-the-active-organization.md)
- [Get a product by ID](https://docs.promptingcompany.com/api/reference/products/get-a-product-by-id.md)
- [Replace product settings by ID](https://docs.promptingcompany.com/api/reference/products/replace-product-settings-by-id.md)
- [Retrieve product knowledge across documents and code](https://docs.promptingcompany.com/api/reference/knowledge/retrieve-product-knowledge-across-documents-and-code.md): Retrieves product-scoped knowledge through public source types. The request uses include values such as documents, generated, and code; raw corpus ids and storage backends are not part of the public contract.
- [Get root public markdown content](https://docs.promptingcompany.com/api/reference/content/get-root-public-markdown-content.md): Retrieves the root public markdown content. Supports standard x-api-key authentication (productId/productSlug via query param or X-Tpc-Product-* headers as fallback) as well as the legacy X-Tpc-* header model.
- [Get public markdown content by ID](https://docs.promptingcompany.com/api/reference/content/get-public-markdown-content-by-id.md): Retrieves public markdown content by ID. Supports standard x-api-key authentication (productId/productSlug via query param or X-Tpc-Product-* headers as fallback) as well as the legacy X-Tpc-* header model.
- [Get public markdown content by path](https://docs.promptingcompany.com/api/reference/content/get-public-markdown-content-by-path.md): Retrieves public markdown content by file path. Supports standard x-api-key authentication (productId/productSlug via query param or X-Tpc-Product-* headers as fallback) as well as the legacy X-Tpc-* header model.
- [List site pages](https://docs.promptingcompany.com/api/reference/content/list-site-pages.md): Deprecated, will be removed in future versions. Please use `GET /api/v1/content` instead.
- [Create site pages](https://docs.promptingcompany.com/api/reference/content/create-site-pages.md): Deprecated, will be removed in future versions. Please use POST /api/v1/content instead.
- [Delete site pages](https://docs.promptingcompany.com/api/reference/content/delete-site-pages.md): Deprecated, will be removed in future versions. Please use DELETE /api/v1/content/{id} instead.
- [Update site pages](https://docs.promptingcompany.com/api/reference/content/update-site-pages.md): Deprecated, will be removed in future versions. Please use PUT /api/v1/content/{id} instead.
- [List content](https://docs.promptingcompany.com/api/reference/content/list-content.md): Unified content list across the lifecycle. `status` selects the view: `published` (default) and `draft` list live site pages; `pending_review`, `generating`, `failed`, `rejected`, and `approved` list content drafts in the review queue. Provide exactly one of `productId` or `productSlug`.
- [Create content](https://docs.promptingcompany.com/api/reference/content/create-content.md): Create content pages. Created pages land in the review queue as `pending_review` drafts and publish only after approval.
- [Generate content for prompts](https://docs.promptingcompany.com/api/reference/content/generate-content-for-prompts.md): Start the content-generation agent for one or more prompts. Each prompt gets a draft (returned with its `draftId` and `runId`); generated content lands in the review queue as `pending_review`, never published directly. Poll `GET /api/v1/content/{draftId}` until `generationStatus` is `completed` or `…
- [Get content](https://docs.promptingcompany.com/api/reference/content/get-content.md): Get one content item by id. Accepts a live document id or a review draft id; `kind` in the response tells which one answered.
- [Replace content](https://docs.promptingcompany.com/api/reference/content/replace-content.md)
- [Delete content](https://docs.promptingcompany.com/api/reference/content/delete-content.md): Delete one content item by id. A live document is soft-deleted along with its linked draft and tracked URL; an unpublished review draft is deleted directly, including drafts still in `generating`.
- [Update content](https://docs.promptingcompany.com/api/reference/content/update-content.md)
- [Cancel in-flight content generation](https://docs.promptingcompany.com/api/reference/content/cancel-in-flight-content-generation.md): Cancel a draft whose generation is still `pending` or `generating`. The draft is marked `cancelled` and soft-deleted so it leaves the generating queue. Completed, failed, rejected, approved, or published drafts return 409 — delete or revert those instead.
- [Review a content draft](https://docs.promptingcompany.com/api/reference/content/review-a-content-draft.md): Approve or reject a draft awaiting review. Approval enqueues publishing for publishable content; rejection stores `feedback` as the rejection reason.
- [Revise a content draft](https://docs.promptingcompany.com/api/reference/content/revise-a-content-draft.md): Submit an edited revision (`content`) or relaunch the generation agent with reviewer `feedback` (Pro plan). Both keep the draft in the review queue and reset a prior rejection.
- [Publish an approved content draft](https://docs.promptingcompany.com/api/reference/content/publish-an-approved-content-draft.md): Queue publishing for an approved review draft. Publishing is gated on approval: an unapproved draft returns 409.
- [Revert published content to the review queue](https://docs.promptingcompany.com/api/reference/content/revert-published-content-to-the-review-queue.md): Unpublish a draft's live document (soft-delete, including its tracked URL) and return the draft to the review queue.
- [Restore archived content](https://docs.promptingcompany.com/api/reference/content/restore-archived-content.md): Restore a soft-deleted live document and its linked draft and tracked URL. Accepts an archived document id.
- [Get a product scraper configuration](https://docs.promptingcompany.com/api/reference/content/get-a-product-scraper-configuration.md)
- [Create or update a product scraper configuration](https://docs.promptingcompany.com/api/reference/content/create-or-update-a-product-scraper-configuration.md)
- [Delete a product scraper configuration](https://docs.promptingcompany.com/api/reference/content/delete-a-product-scraper-configuration.md)
- [Queue a product scraping run](https://docs.promptingcompany.com/api/reference/content/queue-a-product-scraping-run.md)
- [Get content by path](https://docs.promptingcompany.com/api/reference/content/get-content-by-path.md)
- [Update content domains](https://docs.promptingcompany.com/api/reference/content/update-content-domains.md)
- [Search content](https://docs.promptingcompany.com/api/reference/content/search-content.md)
- [Count content](https://docs.promptingcompany.com/api/reference/content/count-content.md)
- [Track a URL for citation analytics](https://docs.promptingcompany.com/api/reference/content/track-a-url-for-citation-analytics.md)
- [Update a tracked URL](https://docs.promptingcompany.com/api/reference/content/update-a-tracked-url.md): Fields you omit keep their stored values. Send null or an empty string to clear title, description, or documentId; an empty category resets it to other. url cannot be cleared.
- [Untrack a URL](https://docs.promptingcompany.com/api/reference/content/untrack-a-url.md)
- [List tracked URLs ranked by citation count](https://docs.promptingcompany.com/api/reference/content/list-tracked-urls-ranked-by-citation-count.md)
- [Get summary metrics for tracked URLs](https://docs.promptingcompany.com/api/reference/content/get-summary-metrics-for-tracked-urls.md)
- [List agent simulation runs](https://docs.promptingcompany.com/api/reference/simulations/list-agent-simulation-runs.md)
- [List Apps](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-apps.md)
- [Create App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app.md)
- [Get App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/get-app.md)
- [Delete App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/delete-app.md)
- [Update App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app.md)
- [List App resources](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-app-resources.md)
- [Attach App resource](https://docs.promptingcompany.com/api/reference/apps-&-publishing/attach-app-resource.md)
- [Detach App resource](https://docs.promptingcompany.com/api/reference/apps-&-publishing/detach-app-resource.md)
- [Update App resource](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app-resource.md)
- [List App domains](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-app-domains.md)
- [Create App domain](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app-domain.md)
- [Delete App domain](https://docs.promptingcompany.com/api/reference/apps-&-publishing/delete-app-domain.md)
- [Update App domain](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app-domain.md)
- [Get web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/get-web-domain-routing-config.md): Deprecated. Web-domain path routing was served by the Web Edge Router, which has been retired; publishing a config no longer affects request routing. These endpoints stop responding after 2026-12-15.
- [Save and publish web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/save-and-publish-web-domain-routing-config.md): Deprecated. Web-domain path routing was served by the Web Edge Router, which has been retired; publishing a config no longer affects request routing. These endpoints stop responding after 2026-12-15.
- [Reset web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/reset-web-domain-routing-config.md): Deprecated. Web-domain path routing was served by the Web Edge Router, which has been retired; publishing a config no longer affects request routing. These endpoints stop responding after 2026-12-15.
- [Validate web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/validate-web-domain-routing-config.md): Deprecated. Web-domain path routing was served by the Web Edge Router, which has been retired; publishing a config no longer affects request routing. These endpoints stop responding after 2026-12-15.
- [Publish web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/publish-web-domain-routing-config.md): Deprecated. Web-domain path routing was served by the Web Edge Router, which has been retired; publishing a config no longer affects request routing. These endpoints stop responding after 2026-12-15.
- [Get App config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/get-app-config.md)
- [Update App config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app-config.md)
- [List App route candidates](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-app-route-candidates.md)
- [List App routes](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-app-routes.md)
- [Create App route](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app-route.md)
- [Auto-create App route for document](https://docs.promptingcompany.com/api/reference/apps-&-publishing/auto-create-app-route-for-document.md)
- [Generate App llms.txt](https://docs.promptingcompany.com/api/reference/apps-&-publishing/generate-app-llmstxt.md)
- [Delete App route](https://docs.promptingcompany.com/api/reference/apps-&-publishing/delete-app-route.md)
- [Update App route](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app-route.md)
- [Preview App route import](https://docs.promptingcompany.com/api/reference/apps-&-publishing/preview-app-route-import.md)
- [Create App routes in batch](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app-routes-in-batch.md)
- [List personas](https://docs.promptingcompany.com/api/reference/personas/list-personas.md): Lists the personas of one product, newest first. Each persona includes promptCount and personal-agent statuses (requested or active). The payload never includes accounts, Kernel profiles, or connection details. Pass the product as productId; brandId is accepted as a legacy alias. page is zero-based.
- [Create a persona](https://docs.promptingcompany.com/api/reference/personas/create-a-persona.md): Creates a persona for the product named by productId (brandId is accepted as a legacy alias). Idempotent on name, case-insensitively: an existing persona with the same name is returned with status 200 instead of being duplicated.
- [Get a persona](https://docs.promptingcompany.com/api/reference/personas/get-a-persona.md)
- [Update a persona](https://docs.promptingcompany.com/api/reference/personas/update-a-persona.md): Replaces the supplied fields of a persona; fields left out are unchanged.
- [Delete a persona](https://docs.promptingcompany.com/api/reference/personas/delete-a-persona.md): Soft-deletes a persona. Prompts that referenced it keep their history.
- [Request personal agents for a persona](https://docs.promptingcompany.com/api/reference/personas/request-personal-agents-for-a-persona.md): Asks the TPC team to add Grok Bot, Muse, or both to a persona. Allowed only when the organization has an active Enterprise plan and that agent's organization flag. The response is the new request statuses and never includes accounts, profiles, or connection details.
- [Cancel a persona's personal agent request](https://docs.promptingcompany.com/api/reference/personas/cancel-a-personas-personal-agent-request.md): Cancels a requested Grok Bot or Muse on a persona. The response is the new request status and never includes accounts, profiles, or connection details.
- [List a prompt's answer engines](https://docs.promptingcompany.com/api/reference/prompts/list-a-prompts-answer-engines.md): Each active conversation query on the prompt, with its engine, location, schedule, last completed answer, pause state, and persona.
- [Get the authenticated user id](https://docs.promptingcompany.com/api/reference/account/get-the-authenticated-user-id.md): Returns the better-auth user id behind the credential. Organization API keys resolve to the user who created the key. Service accounts have no user and are rejected.
- [Introduction](https://docs.promptingcompany.com/ts-sdk/index.md): Access your agentic markdown documentation data with our powerful TypeScript SDK
- [Introduction](https://docs.promptingcompany.com/ts-sdk/introduction.md): Get started with The Prompting Company TypeScript SDK to access agentic markdown documentation data
- [Installation](https://docs.promptingcompany.com/ts-sdk/installation.md): Install and configure The Prompting Company TypeScript SDK in your project
- [Quickstart guide](https://docs.promptingcompany.com/ts-sdk/quickstart.md): Build your first integration with The Prompting Company TypeScript SDK in a Next.js application
- [Advanced usage](https://docs.promptingcompany.com/ts-sdk/advanced-usage.md): Advanced patterns and techniques for using The Prompting Company TypeScript SDK

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Platform](https://app.promptingco.com)
- [GitHub](https://github.com/promptingcompany)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.