# The Prompting Company ## Docs - [Audit log](https://docs.promptingcompany.com/api/audit-log.md): Understand what TPC records for API write requests. - [Authentication](https://docs.promptingcompany.com/api/authentication.md): Choose between session cookies, OAuth bearer tokens, and API keys for the TPC API. - [Agentic documents](https://docs.promptingcompany.com/api/content/documents.md): Use TPC document endpoints for generated content and draft workflows. - [Content API overview](https://docs.promptingcompany.com/api/content/overview.md): Understand the TPC content API surfaces and common workflows. - [Site pages](https://docs.promptingcompany.com/api/content/site-pages.md): Use the TPC Site Pages API to list, create, update, and delete product pages. - [Errors](https://docs.promptingcompany.com/api/errors.md): Handle The Prompting Company API result envelopes, error codes, and request IDs. - [Idempotency](https://docs.promptingcompany.com/api/idempotency.md): Use Idempotency-Key for safe TPC API retries. - [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. - [Rate limits](https://docs.promptingcompany.com/api/rate-limits.md): Understand TPC API quotas, retry headers, and 429 handling. - [Attach App resource](https://docs.promptingcompany.com/api/reference/apps-&-publishing/attach-app-resource.md) - [Create App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app.md) - [Create App domain](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app-domain.md) - [Create App route](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app-route.md) - [Create App routes in batch](https://docs.promptingcompany.com/api/reference/apps-&-publishing/create-app-routes-in-batch.md) - [Delete App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/delete-app.md) - [Delete App domain](https://docs.promptingcompany.com/api/reference/apps-&-publishing/delete-app-domain.md) - [Delete App route](https://docs.promptingcompany.com/api/reference/apps-&-publishing/delete-app-route.md) - [Detach App resource](https://docs.promptingcompany.com/api/reference/apps-&-publishing/detach-app-resource.md) - [Generate App llms.txt](https://docs.promptingcompany.com/api/reference/apps-&-publishing/generate-app-llmstxt.md) - [Get App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/get-app.md) - [Get App config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/get-app-config.md) - [Get web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/get-web-domain-routing-config.md) - [List App domains](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-app-domains.md) - [List App resources](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-app-resources.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) - [List Apps](https://docs.promptingcompany.com/api/reference/apps-&-publishing/list-apps.md) - [Preview App route import](https://docs.promptingcompany.com/api/reference/apps-&-publishing/preview-app-route-import.md) - [Publish web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/publish-web-domain-routing-config.md) - [Reset web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/reset-web-domain-routing-config.md) - [Save and publish web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/save-and-publish-web-domain-routing-config.md) - [Update App](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app.md) - [Update App config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app-config.md) - [Update App resource](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app-resource.md) - [Update App route](https://docs.promptingcompany.com/api/reference/apps-&-publishing/update-app-route.md) - [Validate web-domain routing config](https://docs.promptingcompany.com/api/reference/apps-&-publishing/validate-web-domain-routing-config.md) - [Count content](https://docs.promptingcompany.com/api/reference/content/count-content.md) - [Create or update a product scraper configuration](https://docs.promptingcompany.com/api/reference/content/create-or-update-a-product-scraper-configuration.md) - [Create site pages](https://docs.promptingcompany.com/api/reference/content/create-site-pages.md): Deprecated, will be removed in future versions. Please use the Apps equivalent. - [Delete a product scraper configuration](https://docs.promptingcompany.com/api/reference/content/delete-a-product-scraper-configuration.md) - [Delete site pages](https://docs.promptingcompany.com/api/reference/content/delete-site-pages.md): Deprecated, will be removed in future versions. Please use the Apps equivalent. - [Get a product scraper configuration](https://docs.promptingcompany.com/api/reference/content/get-a-product-scraper-configuration.md) - [Get content](https://docs.promptingcompany.com/api/reference/content/get-content.md) - [Get content by path](https://docs.promptingcompany.com/api/reference/content/get-content-by-path.md) - [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. - [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. - [List site pages](https://docs.promptingcompany.com/api/reference/content/list-site-pages.md): List pages for a product. You must provide exactly one of `productId` or `productSlug` as a query parameter to identify the target product. - [Queue a product scraping run](https://docs.promptingcompany.com/api/reference/content/queue-a-product-scraping-run.md) - [Replace content](https://docs.promptingcompany.com/api/reference/content/replace-content.md) - [Search content](https://docs.promptingcompany.com/api/reference/content/search-content.md) - [Update content](https://docs.promptingcompany.com/api/reference/content/update-content.md) - [Update content domains](https://docs.promptingcompany.com/api/reference/content/update-content-domains.md) - [Update site pages](https://docs.promptingcompany.com/api/reference/content/update-site-pages.md): Deprecated, will be removed in future versions. Please use the Apps equivalent. - [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. - [List agent simulation runs](https://docs.promptingcompany.com/api/reference/simulations/list-agent-simulation-runs.md) - [Create a view](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/create-a-view.md) - [Get share of voice analytics for a product](https://docs.promptingcompany.com/api/reference/visibility-&-mentions/get-share-of-voice-analytics-for-a-product.md) - [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) - [Scopes](https://docs.promptingcompany.com/api/scopes.md): Review the TPC API scope catalog and minimum-scope examples. - [CLI](https://docs.promptingcompany.com/guides/CLI.md): Install and use The Prompting Company CLI - [MCP server](https://docs.promptingcompany.com/guides/MCP-Server.md): Install The Prompting Company MCP server in Claude, Codex, Cursor, VS Code, and other MCP clients - [Add prompts](https://docs.promptingcompany.com/guides/add-prompts.md): Add and manage prompts to track if your product gets mentioned in AI responses - [Environments](https://docs.promptingcompany.com/guides/coding-agent-optimization/environments.md): Configure which agents attempt your tasks and the sandboxes they run in - [Experiments](https://docs.promptingcompany.com/guides/coding-agent-optimization/experiments.md): Run tasks across environments in parallel and read the results - [Overview](https://docs.promptingcompany.com/guides/coding-agent-optimization/overview.md): Evaluate and optimize how coding agents experience your product in sandboxed environments - [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 - [Signals](https://docs.promptingcompany.com/guides/coding-agent-optimization/signals.md): Extract custom metrics from runs with a YAML signal config - [Tasks](https://docs.promptingcompany.com/guides/coding-agent-optimization/tasks.md): Define what agents should accomplish and how success is measured - [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 - [Quickstart guide](https://docs.promptingcompany.com/guides/quickstart-guide.md): The fastest way to get started with The Prompting Company - [Introduction](https://docs.promptingcompany.com/index.md): Access your agentic markdown documentation data with our powerful TypeScript SDK - [Advanced usage](https://docs.promptingcompany.com/ts-sdk/advanced-usage.md): Advanced patterns and techniques for using The Prompting Company TypeScript SDK - [Installation](https://docs.promptingcompany.com/ts-sdk/installation.md): Install and configure The Prompting Company TypeScript SDK in your project - [Introduction](https://docs.promptingcompany.com/ts-sdk/introduction.md): Get started with The Prompting Company TypeScript SDK to access agentic markdown documentation data - [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 ## OpenAPI Specs - [openapi](https://docs.promptingcompany.com/api-reference/openapi.json) ## Optional - [Platform](https://app.promptingco.com) - [GitHub](https://github.com/promptingcompany)