# Mixpeek: v1 API Reference Advanced

## Advanced

### Apps

- [Create an App](https://docs.mixpeek.com/docs/api-reference/apps/create-app.md): Create a new App.
- [List Apps](https://docs.mixpeek.com/docs/api-reference/apps/list-apps.md): List all Apps for this organization.
- [Get an App](https://docs.mixpeek.com/docs/api-reference/apps/get-app.md): Get an App by its `app_id`.
- [Update an App](https://docs.mixpeek.com/docs/api-reference/apps/update-app.md): Partially update an App configuration (saved as draft).
- [Delete an App](https://docs.mixpeek.com/docs/api-reference/apps/delete-app.md): Delete an App permanently.
- [Publish an App](https://docs.mixpeek.com/docs/api-reference/apps/publish-app.md): Publish the current draft config of an App.
- [Rollback an App](https://docs.mixpeek.com/docs/api-reference/apps/rollback-app.md): Rollback to the previous published config version.
- [Get the GitHub App install URL for this app](https://docs.mixpeek.com/docs/api-reference/apps/get-github-app-install-url-app.md): Return the GitHub App installation URL carrying a signed ``state``.

#### Deploy

- [Deploy an App](https://docs.mixpeek.com/docs/api-reference/apps/deploy-app.md): Queue a build+deploy for an App, creating a new version.
- [Get presigned upload URL](https://docs.mixpeek.com/docs/api-reference/apps/get-deploy-upload-url.md): Generate a presigned S3 PUT URL so the CLI can upload a bundle zip directly. Pass the returned `bundle_s3_key` to the deploy endpoint.
- [Get Deploy Status](https://docs.mixpeek.com/docs/api-reference/apps/get-deploy-status.md): Check the status of a specific deployment (queued, building, complete, failed).
- [Stream deploy logs (SSE)](https://docs.mixpeek.com/docs/api-reference/apps/stream-deploy-logs-sse.md): Server-Sent Events stream of real-time deploy logs.
- [Verify a presigned-URL upload landed in S3](https://docs.mixpeek.com/docs/api-reference/apps/verify-a-presigned-url-upload-landed-in-s3.md): Confirm a bundle uploaded via a presigned PUT URL actually landed in S3.
- [Promote staging to production](https://docs.mixpeek.com/docs/api-reference/apps/promote-staging-to-production.md): Promote the current staging deployment to production.

#### GitHub

- [Connect a GitHub repository](https://docs.mixpeek.com/docs/api-reference/apps/connect-a-github-repository.md): Connect a GitHub repository for automatic deploys on push.
- [Disconnect GitHub repository](https://docs.mixpeek.com/docs/api-reference/apps/disconnect-github-repository.md): Disconnect the GitHub repository from this app.

#### Users

- [List app users](https://docs.mixpeek.com/docs/api-reference/apps/list-app-users.md): List all users in this app's Clerk organization.
- [Invite a user](https://docs.mixpeek.com/docs/api-reference/apps/invite-a-user.md): Invite a user to this app by email via Clerk.
- [List pending invitations](https://docs.mixpeek.com/docs/api-reference/apps/list-pending-invitations.md): List pending invitations for this app's Clerk organization.
- [Update user role](https://docs.mixpeek.com/docs/api-reference/apps/update-user-role.md): Update a user's role in this app's Clerk organization.
- [Remove a user](https://docs.mixpeek.com/docs/api-reference/apps/remove-a-user.md): Remove a user from this app's Clerk organization.
- [Revoke an invitation](https://docs.mixpeek.com/docs/api-reference/apps/revoke-an-invitation.md): Revoke a pending invitation.

#### Versions

- [List version history](https://docs.mixpeek.com/docs/api-reference/apps/list-versions.md): Return version history for an App, most recent first.
- [Get Version Details](https://docs.mixpeek.com/docs/api-reference/apps/get-version.md): Return full details for a specific version including asset manifest and source files.
- [Diff Two Versions](https://docs.mixpeek.com/docs/api-reference/apps/diff-versions.md): Compare two versions — returns file-level changes and optional source diffs.
- [Download Version Bundle](https://docs.mixpeek.com/docs/api-reference/apps/download-version.md): Get a presigned download URL for a version's original bundle zip.
- [Restore a Version](https://docs.mixpeek.com/docs/api-reference/apps/restore-version.md): Restore a previous version by pointing the environment to its assets.

#### Domains

- [Add a custom domain](https://docs.mixpeek.com/docs/api-reference/apps/add-domain.md): Attach a custom domain to an App.
- [List custom domains](https://docs.mixpeek.com/docs/api-reference/apps/list-domains.md): List all custom domains attached to an App.
- [Remove a domain](https://docs.mixpeek.com/docs/api-reference/apps/delete-domain.md): Remove a custom domain from an App.
- [Trigger DNS verification](https://docs.mixpeek.com/docs/api-reference/apps/verify-domain.md): Trigger asynchronous DNS TXT record verification for a domain.

#### Analytics

- [Get app analytics overview](https://docs.mixpeek.com/docs/api-reference/apps/get-app-analytics-overview.md): Per-app analytics dashboard data: error trend, Web Vitals, recent errors, event counts.
- [Get recent error rate](https://docs.mixpeek.com/docs/api-reference/apps/get-recent-error-rate.md): Query ClickHouse canvas_errors for the error count in the last N minutes.
- [Get runtime or request logs](https://docs.mixpeek.com/docs/api-reference/apps/get-runtime-or-request-logs.md): Query ClickHouse canvas_app_logs or canvas_request_logs.

#### Public

- [Get public App config](https://docs.mixpeek.com/docs/api-reference/public-apps-api/get-app-config.md): Fetch the full configuration for a public App — no authentication required.
- [Execute an App tab search](https://docs.mixpeek.com/docs/api-reference/public-apps-api/search-app.md): Execute a search on a specific tab of a public App — no authentication required.
- [Get App featured gallery](https://docs.mixpeek.com/docs/api-reference/public-apps-api/get-app-gallery.md): Fetch featured gallery results for a public App — no authentication required.
- [Get taxonomy node tree for an App](https://docs.mixpeek.com/docs/api-reference/public-apps-api/get-app-taxonomies.md): Fetch the node tree for a taxonomy associated with a public App — no authentication required.
- [Track an App interaction event](https://docs.mixpeek.com/docs/api-reference/public-apps-api/track-app-interaction.md): Record a user interaction event for a public App — no authentication required.

### Agent Sessions

- [Create Session](https://docs.mixpeek.com/docs/api-reference/agent-sessions/create-session.md): Create a new agent session.
- [List Sessions](https://docs.mixpeek.com/docs/api-reference/agent-sessions/list-sessions.md): List agent sessions in the namespace.
- [Get Session](https://docs.mixpeek.com/docs/api-reference/agent-sessions/get-session.md): Get session metadata by ID.
- [Patch Session](https://docs.mixpeek.com/docs/api-reference/agent-sessions/patch-session.md): Update session metadata.
- [Send Message](https://docs.mixpeek.com/docs/api-reference/agent-sessions/send-message.md): Send a message to the agent and stream the response.
- [Get History](https://docs.mixpeek.com/docs/api-reference/agent-sessions/get-history.md): Get conversation history for a session.
- [List Tools](https://docs.mixpeek.com/docs/api-reference/agent-sessions/list-tools.md): List all available agent tools.
- [Detect Intent](https://docs.mixpeek.com/docs/api-reference/agent-sessions/detect-intent.md): Detect user intent from natural language request.
- [Respond To Confirmation](https://docs.mixpeek.com/docs/api-reference/agent-sessions/respond-to-confirmation.md): Respond to a pending confirmation for a write operation.
- [Submit Feedback](https://docs.mixpeek.com/docs/api-reference/agent-sessions/submit-feedback.md): Submit feedback on an assistant message.
- [Terminate Session](https://docs.mixpeek.com/docs/api-reference/agent-sessions/terminate-session.md): Terminate a session and kill its actor.

### Templates

#### Namespace

- [List Namespace Templates](https://docs.mixpeek.com/docs/api-reference/templates/list-namespace-templates.md): List namespace templates (system + organization + user).
- [Get Namespace Template](https://docs.mixpeek.com/docs/api-reference/templates/get-namespace-template.md): Get namespace template details.
- [Create Namespace Template](https://docs.mixpeek.com/docs/api-reference/templates/create-namespace-template.md): Create template from existing namespace.
- [Instantiate Namespace Template](https://docs.mixpeek.com/docs/api-reference/templates/instantiate-namespace-template.md): Instantiate namespace template.

#### Retriever

- [List Retriever Templates](https://docs.mixpeek.com/docs/api-reference/templates/list-retriever-templates.md): List retriever templates (system + organization + user).
- [Get Retriever Template](https://docs.mixpeek.com/docs/api-reference/templates/get-retriever-template.md): Get retriever template details.
- [Create Retriever Template](https://docs.mixpeek.com/docs/api-reference/templates/create-retriever-template.md): Create template from existing retriever.
- [Instantiate Retriever Template](https://docs.mixpeek.com/docs/api-reference/templates/instantiate-retriever-template.md): Instantiate retriever template.

#### Collection

- [List Collection Templates](https://docs.mixpeek.com/docs/api-reference/templates/list-collection-templates.md): List collection templates (system + organization + user).
- [Get Collection Template](https://docs.mixpeek.com/docs/api-reference/templates/get-collection-template.md): Get collection template details.
- [Create Collection Template](https://docs.mixpeek.com/docs/api-reference/templates/create-collection-template.md): Create template from existing collection.
- [Instantiate Collection Template](https://docs.mixpeek.com/docs/api-reference/templates/instantiate-collection-template.md): Instantiate collection template.

#### Bucket

- [List Bucket Templates](https://docs.mixpeek.com/docs/api-reference/templates/list-bucket-templates.md): List bucket templates (system + organization + user).
- [Get Bucket Template](https://docs.mixpeek.com/docs/api-reference/templates/get-bucket-template.md): Get bucket template details.
- [Create Bucket Template](https://docs.mixpeek.com/docs/api-reference/templates/create-bucket-template.md): Create template from existing bucket.
- [Instantiate Bucket Template](https://docs.mixpeek.com/docs/api-reference/templates/instantiate-bucket-template.md): Instantiate bucket template.

#### Cluster

- [List Cluster Templates](https://docs.mixpeek.com/docs/api-reference/templates/list-cluster-templates.md): List cluster templates (system + organization + user).
- [Get Cluster Template](https://docs.mixpeek.com/docs/api-reference/templates/get-cluster-template.md): Get cluster template details.
- [Create Cluster Template](https://docs.mixpeek.com/docs/api-reference/templates/create-cluster-template.md): Create template from existing cluster.
- [Instantiate Cluster Template](https://docs.mixpeek.com/docs/api-reference/templates/instantiate-cluster-template.md): Instantiate cluster template.

#### Taxonomy

- [List Taxonomy Templates](https://docs.mixpeek.com/docs/api-reference/templates/list-taxonomy-templates.md): List taxonomy templates (system + organization + user).
- [Get Taxonomy Template](https://docs.mixpeek.com/docs/api-reference/templates/get-taxonomy-template.md): Get taxonomy template details.
- [Create Taxonomy Template](https://docs.mixpeek.com/docs/api-reference/templates/create-taxonomy-template.md): Create template from existing taxonomy.
- [Instantiate Taxonomy Template](https://docs.mixpeek.com/docs/api-reference/templates/instantiate-taxonomy-template.md): Instantiate taxonomy template.

#### Public Templates

- [List Public Namespace Templates](https://docs.mixpeek.com/docs/api-reference/public-templates-api/list-public-namespace-templates.md): List public namespace templates (no authentication required).
- [Get Public Namespace Template](https://docs.mixpeek.com/docs/api-reference/public-templates-api/get-public-namespace-template.md): Get public namespace template details (no authentication required).
- [List Public Retriever Templates](https://docs.mixpeek.com/docs/api-reference/public-templates-api/list-public-retriever-templates.md): List public retriever templates (no authentication required).
- [Get Public Retriever Template](https://docs.mixpeek.com/docs/api-reference/public-templates-api/get-public-retriever-template.md): Get public retriever template details (no authentication required).
- [List Scaffolds](https://docs.mixpeek.com/docs/api-reference/public-templates-api/list-scaffolds.md): List available scaffold templates (public, no auth required).
- [Get Scaffold](https://docs.mixpeek.com/docs/api-reference/public-templates-api/get-scaffold.md): Get scaffold template details (public, no auth required).
- [Get Scaffold Sample Data](https://docs.mixpeek.com/docs/api-reference/public-templates-api/get-scaffold-sample-data.md): Live per-collection document counts of the scaffold's golden sample namespace (public, no auth required).
- [Get Scaffold Manifest](https://docs.mixpeek.com/docs/api-reference/public-templates-api/get-scaffold-manifest.md): Render a scaffold template as a Mixpeek manifest (public, no auth).

#### Scaffold Templates

- [Get Or Create Default Namespace](https://docs.mixpeek.com/docs/api-reference/scaffold-templates/get-or-create-default-namespace.md): Get or create the default universal namespace.
- [Get Scaffold Template Manifest](https://docs.mixpeek.com/docs/api-reference/scaffold-templates/get-scaffold-template-manifest.md): Render a scaffold template as a Mixpeek manifest.

### Manifest

- [Apply Manifest](https://docs.mixpeek.com/docs/api-reference/manifest/apply-manifest.md): Apply a YAML manifest to create resources.
- [Validate Manifest](https://docs.mixpeek.com/docs/api-reference/manifest/validate-manifest.md): Validate a YAML manifest without applying.
- [Export Manifest Get](https://docs.mixpeek.com/docs/api-reference/manifest/export-manifest.md): Export current resources to a YAML manifest.
- [Diff Manifest](https://docs.mixpeek.com/docs/api-reference/manifest/diff-manifest.md): Compare a manifest file with current state.
- [Generate Manifest](https://docs.mixpeek.com/docs/api-reference/manifest/generate-manifest.md): Generate a manifest from natural language description.
- [Lint Manifest](https://docs.mixpeek.com/docs/api-reference/manifest/lint-manifest.md): Lint a YAML manifest for best practices and potential issues.

### Analytics

#### Namespace

- [Get Namespace Summary](https://docs.mixpeek.com/docs/api-reference/analytics/get-namespace-summary.md): Get comprehensive namespace optimization summary.
- [Get Field Usage](https://docs.mixpeek.com/docs/api-reference/analytics/get-field-usage.md): Get usage statistics for all filtered fields.
- [Get Field Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-field-performance.md): Analyze field performance correlation.
- [Get Most Queried Fields](https://docs.mixpeek.com/docs/api-reference/analytics/get-most-queried-fields.md): Get most frequently queried metadata fields.
- [Get Compound Index Patterns](https://docs.mixpeek.com/docs/api-reference/analytics/get-compound-index-patterns.md): Identify compound index opportunities.
- [Get Index Recommendations](https://docs.mixpeek.com/docs/api-reference/analytics/get-index-recommendations.md): Get comprehensive MongoDB index recommendations.
- [Get Index Suggestions](https://docs.mixpeek.com/docs/api-reference/analytics/get-index-suggestions.md): Get index suggestions based on filter usage patterns.
- [Get Namespace Errors](https://docs.mixpeek.com/docs/api-reference/analytics/get-namespace-errors.md): Batch error/failure counts for every collection & cluster in the namespace.

#### Buckets

- [Get Bucket Health](https://docs.mixpeek.com/docs/api-reference/analytics/get-bucket-health.md): Get bucket health monitoring metrics.
- [Get Namespace Buckets Health](https://docs.mixpeek.com/docs/api-reference/analytics/get-namespace-buckets-health.md): Get health for ALL buckets in the namespace in one request.
- [Get Bucket Storage](https://docs.mixpeek.com/docs/api-reference/analytics/get-bucket-storage.md): Get storage growth trends over time.
- [Get Bucket Usage](https://docs.mixpeek.com/docs/api-reference/analytics/get-bucket-usage.md): Get usage and cost metrics.
- [Get Sync Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-sync-performance.md): Get sync performance metrics.
- [Get Sync Comparison](https://docs.mixpeek.com/docs/api-reference/analytics/get-sync-comparison.md): Compare performance across sync configurations.
- [Get Upload Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-upload-performance.md): Get upload performance metrics.

#### Collections

- [Get Collection Overview](https://docs.mixpeek.com/docs/api-reference/analytics/get-collection-overview.md): Get high-level collection health and status metrics.
- [Get Document Growth](https://docs.mixpeek.com/docs/api-reference/analytics/get-document-growth.md): Get document growth trends over time.
- [Get Latency Metrics](https://docs.mixpeek.com/docs/api-reference/analytics/get-latency-metrics.md): Get processing latency distribution.
- [Get Failure Analysis](https://docs.mixpeek.com/docs/api-reference/analytics/get-failure-analysis.md): Get failure analysis metrics.
- [Get Extractor Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-extractor-performance.md): Get feature extraction performance metrics.

#### Retrievers

- [Get Retriever Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-retriever-performance.md): Get retriever performance metrics for tuning.
- [Get Retriever Signals](https://docs.mixpeek.com/docs/api-reference/analytics/get-retriever-signals.md): Get retriever signals for interaction tuning.
- [Get Slow Queries](https://docs.mixpeek.com/docs/api-reference/analytics/get-slow-queries.md): Get slow queries and their filter patterns.
- [Get Stage Breakdown](https://docs.mixpeek.com/docs/api-reference/analytics/get-stage-breakdown.md): Get stage-level performance breakdown.
- [Get Cache Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-cache-performance.md): Get cache performance metrics.
- [Analyze For Tuning](https://docs.mixpeek.com/docs/api-reference/analytics/analyze-for-tuning.md): Analyze retriever and generate tuning recommendations.

#### Engine

- [Get Engine Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-engine-performance.md): Get engine performance metrics over time.
- [Analyze Bottlenecks](https://docs.mixpeek.com/docs/api-reference/analytics/analyze-bottlenecks.md): Identify performance bottlenecks.
- [Get Extractor Breakdown](https://docs.mixpeek.com/docs/api-reference/analytics/get-extractor-breakdown.md): Get extractor performance breakdown.
- [Get Engine Stage Breakdown](https://docs.mixpeek.com/docs/api-reference/analytics/get-engine-stage-breakdown.md): Get stage-level performance breakdown.
- [Get Slowest Operations](https://docs.mixpeek.com/docs/api-reference/analytics/get-slowest-operations.md): Get slowest individual operations.

#### Taxonomies

- [Get Assignment Metrics](https://docs.mixpeek.com/docs/api-reference/analytics/get-assignment-metrics.md): Get taxonomy assignment metrics over time.
- [Get Confidence Distribution](https://docs.mixpeek.com/docs/api-reference/analytics/get-confidence-distribution.md): Get confidence score distribution.
- [Get Label Distribution](https://docs.mixpeek.com/docs/api-reference/analytics/get-label-distribution.md): Get label distribution.
- [Get Enrichment History](https://docs.mixpeek.com/docs/api-reference/analytics/get-enrichment-history.md): Get enrichment execution history.

#### Clusters

- [Get Execution History](https://docs.mixpeek.com/docs/api-reference/analytics/get-execution-history.md): Get cluster execution history with metrics.
- [Get Failure Analysis](https://docs.mixpeek.com/docs/api-reference/analytics/get-failure-analysis-1.md): Get cluster failure analysis.

#### Inference & Extractors

- [Get Inference Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-inference-performance.md): Inference performance metrics. Not implemented.
- [Get Extractor Performance](https://docs.mixpeek.com/docs/api-reference/analytics/get-extractor-performance-1.md): Get feature extractor performance breakdown.

#### Diagnostics

- [Get Batch Diagnostics](https://docs.mixpeek.com/docs/api-reference/analytics/get-batch-diagnostics.md): Get comprehensive diagnostics for a batch.
- [Get Usage Summary](https://docs.mixpeek.com/docs/api-reference/analytics/get-usage-summary.md): Get usage summary for billing.
- [Get Slowest Queries](https://docs.mixpeek.com/docs/api-reference/analytics/get-slowest-queries.md): Get slowest queries for troubleshooting.

### Discovery

- [Get All Discovery Information](https://docs.mixpeek.com/docs/api-reference/discovery/get-all-discovery-information.md): Returns combined discovery information including extractors, stages, and manifest schema in a single request. Use this for comprehensive capability discovery.
- [List Available Feature Extractors](https://docs.mixpeek.com/docs/api-reference/discovery/list-available-feature-extractors.md): Discover all available feature extractors with their capabilities, supported modalities, output features, and example usage. Use this to understand what extractors are available when configuring namespaces and collections in manifests.
- [List Available Retriever Stages with Examples](https://docs.mixpeek.com/docs/api-reference/discovery/list-available-retriever-stages-with-examples.md): Discover all available retriever stages with extended information including example configurations, common use cases, and cost tiers. This endpoint provides more context than /v1/retrievers/stages for agent-driven configuration.
- [Get Manifest Schema for Agent Configuration](https://docs.mixpeek.com/docs/api-reference/discovery/get-manifest-schema-for-agent-configuration.md): Returns the complete manifest schema including all resource types, their JSON schemas, dependency graph, and YAML examples. Use this for programmatic manifest generation and validation.

### Inference

- [Execute Raw Inference](https://docs.mixpeek.com/docs/api-reference/inference/execute-raw-inference.md): Execute raw inference with provider+model or custom plugin.

### Events

- [List change feed events](https://docs.mixpeek.com/docs/api-reference/events/list-events.md): List this organization's change feed, ordered and resumable by cursor.

### Resource Search

- [Search Resources](https://docs.mixpeek.com/docs/api-reference/resource-search/search-resources.md): Search across all resource names and IDs within your namespace.

### Onboarding

- [Infer onboarding configuration](https://docs.mixpeek.com/docs/api-reference/onboarding/infer-onboarding-configuration.md): Given a free-text use-case description, uses an LLM to recommend the best scaffold template, extractors, retriever stages, and sample queries for the user's project.
- [Get the org's signup-time suggested namespace](https://docs.mixpeek.com/docs/api-reference/onboarding/get-suggested-config.md): Returns the namespace configuration that was suggested from Mixpeek's company research at signup, if one was provisioned. Studio uses this to badge the suggested namespace.