Skip to content

Latest commit

 

History

History
1604 lines (1566 loc) · 158 KB

File metadata and controls

1604 lines (1566 loc) · 158 KB

mixpeek

This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.81.1
  • Package version: 0.81.1
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://mixpeek.com/contact

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import mixpeek

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import mixpeek

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)



# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.AdhocRetrieversApi(api_client)
    adhoc_execute_request = mixpeek.AdhocExecuteRequest() # AdhocExecuteRequest | 
    return_presigned_urls = False # bool |  (optional) (default to False)
    return_vectors = False # bool |  (optional) (default to False)
    authorization = 'authorization_example' # str | REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. (optional)
    authorization2 = 'authorization_example' # str |  (optional)
    x_namespace = 'x_namespace_example' # str | REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' (optional)

    try:
        # Execute Adhoc Retriever
        api_response = api_instance.execute_adhoc_retriever(adhoc_execute_request, return_presigned_urls=return_presigned_urls, return_vectors=return_vectors, authorization=authorization, authorization2=authorization2, x_namespace=x_namespace)
        print("The response of AdhocRetrieversApi->execute_adhoc_retriever:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdhocRetrieversApi->execute_adhoc_retriever: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.mixpeek.com

Class Method HTTP request Description
AdhocRetrieversApi execute_adhoc_retriever POST /v1/retrievers/execute Execute Adhoc Retriever
AdhocRetrieversApi get_adhoc_execution_retrievers GET /v1/retrievers/executions/{execution_id} Get Adhoc Execution
AdhocRetrieversApi list_adhoc_executions_retrievers POST /v1/retrievers/executions/list List Adhoc Executions
AgentSessionsApi create_session_agents POST /v1/agents/sessions Create Session
AgentSessionsApi detect_intent_agents_sessions POST /v1/agents/sessions/intent/detect Detect Intent
AgentSessionsApi get_history_agents_sessions GET /v1/agents/sessions/{session_id}/history Get History
AgentSessionsApi get_session_agents GET /v1/agents/sessions/{session_id} Get Session
AgentSessionsApi list_sessions_agents POST /v1/agents/sessions/list List Sessions
AgentSessionsApi list_tools_agents_sessions GET /v1/agents/sessions/tools List Tools
AgentSessionsApi patch_session_agents PATCH /v1/agents/sessions/{session_id} Patch Session
AgentSessionsApi respond_to_confirmation_agents_sessions POST /v1/agents/sessions/{session_id}/confirmations/{confirmation_id} Respond To Confirmation
AgentSessionsApi send_message_agents_sessions POST /v1/agents/sessions/{session_id}/messages Send Message
AgentSessionsApi submit_feedback_agents_sessions POST /v1/agents/sessions/{session_id}/feedback Submit Feedback
AgentSessionsApi terminate_session_agents DELETE /v1/agents/sessions/{session_id} Terminate Session
AlertsApi create_alert POST /v1/alerts Create Alert
AlertsApi create_alert_0 POST /v1/alerts Create Alert
AlertsApi delete_alert DELETE /v1/alerts/{alert_identifier} Delete Alert
AlertsApi delete_alert_0 DELETE /v1/alerts/{alert_identifier} Delete Alert
AlertsApi get_alert GET /v1/alerts/{alert_identifier} Get Alert
AlertsApi get_alert_0 GET /v1/alerts/{alert_identifier} Get Alert
AlertsApi list_alert_executions GET /v1/alerts/{alert_identifier}/executions List Alert Executions
AlertsApi list_alert_executions_0 GET /v1/alerts/{alert_identifier}/executions List Alert Executions
AlertsApi list_alerts POST /v1/alerts/list List Alerts
AlertsApi list_alerts_0 POST /v1/alerts/list List Alerts
AlertsApi list_all_executions_alerts GET /v1/alerts/executions List All Executions
AlertsApi list_all_executions_alerts_0 GET /v1/alerts/executions List All Executions
AlertsApi patch_alert PATCH /v1/alerts/{alert_identifier} Update Alert
AlertsApi patch_alert_0 PATCH /v1/alerts/{alert_identifier} Update Alert
AnalyticsApi analyze_bottlenecks_analytics_performance_engine GET /v1/analytics/performance/engine/bottlenecks Analyze Bottlenecks
AnalyticsApi analyze_bottlenecks_analytics_performance_engine_0 GET /v1/analytics/performance/engine/bottlenecks Analyze Bottlenecks
AnalyticsApi analyze_for_tuning_analytics_retrievers POST /v1/analytics/retrievers/{retriever_id}/analyze-tuning Analyze For Tuning
AnalyticsApi analyze_for_tuning_analytics_retrievers_0 POST /v1/analytics/retrievers/{retriever_id}/analyze-tuning Analyze For Tuning
AnalyticsApi get_assignment_metrics_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/assignments Get Assignment Metrics
AnalyticsApi get_assignment_metrics_analytics_taxonomies_taxonomy_0 GET /v1/analytics/taxonomies/{taxonomy_id}/assignments Get Assignment Metrics
AnalyticsApi get_batch_diagnostics_analytics_performance_batches GET /v1/analytics/performance/batches/{batch_id}/diagnostics Get Batch Diagnostics
AnalyticsApi get_batch_diagnostics_analytics_performance_batches_0 GET /v1/analytics/performance/batches/{batch_id}/diagnostics Get Batch Diagnostics
AnalyticsApi get_bucket_health_analytics GET /v1/analytics/buckets/{bucket_id}/health Get Bucket Health
AnalyticsApi get_bucket_health_analytics_0 GET /v1/analytics/buckets/{bucket_id}/health Get Bucket Health
AnalyticsApi get_bucket_storage_analytics GET /v1/analytics/buckets/{bucket_id}/storage Get Bucket Storage
AnalyticsApi get_bucket_storage_analytics_0 GET /v1/analytics/buckets/{bucket_id}/storage Get Bucket Storage
AnalyticsApi get_bucket_usage_analytics GET /v1/analytics/buckets/{bucket_id}/usage Get Bucket Usage
AnalyticsApi get_bucket_usage_analytics_0 GET /v1/analytics/buckets/{bucket_id}/usage Get Bucket Usage
AnalyticsApi get_cache_performance_analytics_retrievers GET /v1/analytics/retrievers/{retriever_id}/cache-performance Get Cache Performance
AnalyticsApi get_cache_performance_analytics_retrievers_0 GET /v1/analytics/retrievers/{retriever_id}/cache-performance Get Cache Performance
AnalyticsApi get_collection_overview_analytics GET /v1/analytics/collections/{collection_id}/overview Get Collection Overview
AnalyticsApi get_collection_overview_analytics_0 GET /v1/analytics/collections/{collection_id}/overview Get Collection Overview
AnalyticsApi get_compound_index_patterns_analytics_namespaces_indexes GET /v1/analytics/namespaces/indexes/compound-patterns Get Compound Index Patterns
AnalyticsApi get_compound_index_patterns_analytics_namespaces_indexes_0 GET /v1/analytics/namespaces/indexes/compound-patterns Get Compound Index Patterns
AnalyticsApi get_confidence_distribution_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/confidence Get Confidence Distribution
AnalyticsApi get_confidence_distribution_analytics_taxonomies_taxonomy_0 GET /v1/analytics/taxonomies/{taxonomy_id}/confidence Get Confidence Distribution
AnalyticsApi get_document_growth_analytics GET /v1/analytics/collections/{collection_id}/growth Get Document Growth
AnalyticsApi get_document_growth_analytics_0 GET /v1/analytics/collections/{collection_id}/growth Get Document Growth
AnalyticsApi get_engine_performance_analytics GET /v1/analytics/performance/engine Get Engine Performance
AnalyticsApi get_engine_performance_analytics_0 GET /v1/analytics/performance/engine Get Engine Performance
AnalyticsApi get_engine_stage_breakdown_analytics_performance GET /v1/analytics/performance/engine/stages Get Engine Stage Breakdown
AnalyticsApi get_engine_stage_breakdown_analytics_performance_0 GET /v1/analytics/performance/engine/stages Get Engine Stage Breakdown
AnalyticsApi get_enrichment_history_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/enrichments Get Enrichment History
AnalyticsApi get_enrichment_history_analytics_taxonomies_taxonomy_0 GET /v1/analytics/taxonomies/{taxonomy_id}/enrichments Get Enrichment History
AnalyticsApi get_execution_history_analytics_clusters GET /v1/analytics/clusters/{cluster_id}/execution-history Get Execution History
AnalyticsApi get_execution_history_analytics_clusters_0 GET /v1/analytics/clusters/{cluster_id}/execution-history Get Execution History
AnalyticsApi get_extractor_breakdown_analytics_performance_engine GET /v1/analytics/performance/engine/extractors Get Extractor Breakdown
AnalyticsApi get_extractor_breakdown_analytics_performance_engine_0 GET /v1/analytics/performance/engine/extractors Get Extractor Breakdown
AnalyticsApi get_extractor_performance_analytics GET /v1/analytics/extractors/performance Get Extractor Performance
AnalyticsApi get_extractor_performance_analytics_0 GET /v1/analytics/extractors/performance Get Extractor Performance
AnalyticsApi get_extractor_performance_analytics_1 GET /v1/analytics/collections/{collection_id}/extractors Get Extractor Performance
AnalyticsApi get_extractor_performance_analytics_2 GET /v1/analytics/collections/{collection_id}/extractors Get Extractor Performance
AnalyticsApi get_failure_analysis_analytics GET /v1/analytics/collections/{collection_id}/failures Get Failure Analysis
AnalyticsApi get_failure_analysis_analytics_0 GET /v1/analytics/collections/{collection_id}/failures Get Failure Analysis
AnalyticsApi get_failure_analysis_analytics_clusters GET /v1/analytics/clusters/{cluster_id}/failures Get Failure Analysis
AnalyticsApi get_failure_analysis_analytics_clusters_0 GET /v1/analytics/clusters/{cluster_id}/failures Get Failure Analysis
AnalyticsApi get_field_performance_analytics_namespaces GET /v1/analytics/namespaces/fields/performance Get Field Performance
AnalyticsApi get_field_performance_analytics_namespaces_0 GET /v1/analytics/namespaces/fields/performance Get Field Performance
AnalyticsApi get_field_usage_analytics_indexes GET /v1/analytics/indexes/usage Get Field Usage
AnalyticsApi get_field_usage_analytics_indexes_0 GET /v1/analytics/indexes/usage Get Field Usage
AnalyticsApi get_index_recommendations_analytics_namespaces_indexes GET /v1/analytics/namespaces/indexes/recommendations Get Index Recommendations
AnalyticsApi get_index_recommendations_analytics_namespaces_indexes_0 GET /v1/analytics/namespaces/indexes/recommendations Get Index Recommendations
AnalyticsApi get_index_suggestions_analytics_indexes GET /v1/analytics/indexes/suggestions Get Index Suggestions
AnalyticsApi get_index_suggestions_analytics_indexes_0 GET /v1/analytics/indexes/suggestions Get Index Suggestions
AnalyticsApi get_inference_performance_analytics GET /v1/analytics/inference/performance Get Inference Performance
AnalyticsApi get_inference_performance_analytics_0 GET /v1/analytics/inference/performance Get Inference Performance
AnalyticsApi get_label_distribution_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/labels Get Label Distribution
AnalyticsApi get_label_distribution_analytics_taxonomies_taxonomy_0 GET /v1/analytics/taxonomies/{taxonomy_id}/labels Get Label Distribution
AnalyticsApi get_latency_metrics_analytics GET /v1/analytics/collections/{collection_id}/latency Get Latency Metrics
AnalyticsApi get_latency_metrics_analytics_0 GET /v1/analytics/collections/{collection_id}/latency Get Latency Metrics
AnalyticsApi get_most_queried_fields_analytics_namespaces GET /v1/analytics/namespaces/fields/most-queried Get Most Queried Fields
AnalyticsApi get_most_queried_fields_analytics_namespaces_0 GET /v1/analytics/namespaces/fields/most-queried Get Most Queried Fields
AnalyticsApi get_namespace_summary_analytics GET /v1/analytics/namespaces/summary Get Namespace Summary
AnalyticsApi get_namespace_summary_analytics_0 GET /v1/analytics/namespaces/summary Get Namespace Summary
AnalyticsApi get_retriever_performance_analytics GET /v1/analytics/retrievers/{retriever_id}/performance Get Retriever Performance
AnalyticsApi get_retriever_performance_analytics_0 GET /v1/analytics/retrievers/{retriever_id}/performance Get Retriever Performance
AnalyticsApi get_retriever_signals_analytics GET /v1/analytics/retrievers/{retriever_id}/signals Get Retriever Signals
AnalyticsApi get_retriever_signals_analytics_0 GET /v1/analytics/retrievers/{retriever_id}/signals Get Retriever Signals
AnalyticsApi get_slow_queries_analytics_namespaces GET /v1/analytics/namespaces/queries/slow Get Slow Queries
AnalyticsApi get_slow_queries_analytics_namespaces_0 GET /v1/analytics/namespaces/queries/slow Get Slow Queries
AnalyticsApi get_slowest_operations_analytics_performance_engine_slow GET /v1/analytics/performance/engine/slow-operations Get Slowest Operations
AnalyticsApi get_slowest_operations_analytics_performance_engine_slow_0 GET /v1/analytics/performance/engine/slow-operations Get Slowest Operations
AnalyticsApi get_slowest_queries_analytics_retrievers_id_slow GET /v1/analytics/retrievers/{retriever_id}/slow-queries Get Slowest Queries
AnalyticsApi get_slowest_queries_analytics_retrievers_id_slow_0 GET /v1/analytics/retrievers/{retriever_id}/slow-queries Get Slowest Queries
AnalyticsApi get_stage_breakdown_analytics_retrievers GET /v1/analytics/retrievers/{retriever_id}/stages Get Stage Breakdown
AnalyticsApi get_stage_breakdown_analytics_retrievers_0 GET /v1/analytics/retrievers/{retriever_id}/stages Get Stage Breakdown
AnalyticsApi get_sync_comparison_analytics_buckets GET /v1/analytics/buckets/{bucket_id}/sync-comparison Get Sync Comparison
AnalyticsApi get_sync_comparison_analytics_buckets_0 GET /v1/analytics/buckets/{bucket_id}/sync-comparison Get Sync Comparison
AnalyticsApi get_sync_performance_analytics_buckets GET /v1/analytics/buckets/{bucket_id}/sync-performance Get Sync Performance
AnalyticsApi get_sync_performance_analytics_buckets_0 GET /v1/analytics/buckets/{bucket_id}/sync-performance Get Sync Performance
AnalyticsApi get_upload_performance_analytics_buckets GET /v1/analytics/buckets/{bucket_id}/upload-performance Get Upload Performance
AnalyticsApi get_upload_performance_analytics_buckets_0 GET /v1/analytics/buckets/{bucket_id}/upload-performance Get Upload Performance
AnalyticsApi get_usage_summary_analytics GET /v1/analytics/usage/summary Get Usage Summary
AnalyticsApi get_usage_summary_analytics_0 GET /v1/analytics/usage/summary Get Usage Summary
AnalyticsBucketsApi get_bucket_health_analytics GET /v1/analytics/buckets/{bucket_id}/health Get Bucket Health
AnalyticsBucketsApi get_bucket_storage_analytics GET /v1/analytics/buckets/{bucket_id}/storage Get Bucket Storage
AnalyticsBucketsApi get_bucket_usage_analytics GET /v1/analytics/buckets/{bucket_id}/usage Get Bucket Usage
AnalyticsBucketsApi get_sync_comparison_analytics_buckets GET /v1/analytics/buckets/{bucket_id}/sync-comparison Get Sync Comparison
AnalyticsBucketsApi get_sync_performance_analytics_buckets GET /v1/analytics/buckets/{bucket_id}/sync-performance Get Sync Performance
AnalyticsBucketsApi get_upload_performance_analytics_buckets GET /v1/analytics/buckets/{bucket_id}/upload-performance Get Upload Performance
AnalyticsClustersApi get_execution_history_analytics_clusters GET /v1/analytics/clusters/{cluster_id}/execution-history Get Execution History
AnalyticsClustersApi get_failure_analysis_analytics_clusters GET /v1/analytics/clusters/{cluster_id}/failures Get Failure Analysis
AnalyticsCollectionsApi get_collection_overview_analytics GET /v1/analytics/collections/{collection_id}/overview Get Collection Overview
AnalyticsCollectionsApi get_document_growth_analytics GET /v1/analytics/collections/{collection_id}/growth Get Document Growth
AnalyticsCollectionsApi get_extractor_performance_analytics GET /v1/analytics/collections/{collection_id}/extractors Get Extractor Performance
AnalyticsCollectionsApi get_failure_analysis_analytics GET /v1/analytics/collections/{collection_id}/failures Get Failure Analysis
AnalyticsCollectionsApi get_latency_metrics_analytics GET /v1/analytics/collections/{collection_id}/latency Get Latency Metrics
AnalyticsExtractorsApi get_extractor_performance_analytics GET /v1/analytics/extractors/performance Get Extractor Performance
AnalyticsIndexesApi get_field_usage_analytics_indexes GET /v1/analytics/indexes/usage Get Field Usage
AnalyticsIndexesApi get_index_suggestions_analytics_indexes GET /v1/analytics/indexes/suggestions Get Index Suggestions
AnalyticsInferenceApi get_inference_performance_analytics GET /v1/analytics/inference/performance Get Inference Performance
AnalyticsNamespacesApi get_compound_index_patterns_analytics_namespaces_indexes GET /v1/analytics/namespaces/indexes/compound-patterns Get Compound Index Patterns
AnalyticsNamespacesApi get_field_performance_analytics_namespaces GET /v1/analytics/namespaces/fields/performance Get Field Performance
AnalyticsNamespacesApi get_index_recommendations_analytics_namespaces_indexes GET /v1/analytics/namespaces/indexes/recommendations Get Index Recommendations
AnalyticsNamespacesApi get_most_queried_fields_analytics_namespaces GET /v1/analytics/namespaces/fields/most-queried Get Most Queried Fields
AnalyticsNamespacesApi get_namespace_summary_analytics GET /v1/analytics/namespaces/summary Get Namespace Summary
AnalyticsNamespacesApi get_slow_queries_analytics_namespaces GET /v1/analytics/namespaces/queries/slow Get Slow Queries
AnalyticsPerformanceApi analyze_bottlenecks_analytics_performance_engine GET /v1/analytics/performance/engine/bottlenecks Analyze Bottlenecks
AnalyticsPerformanceApi get_batch_diagnostics_analytics_performance_batches GET /v1/analytics/performance/batches/{batch_id}/diagnostics Get Batch Diagnostics
AnalyticsPerformanceApi get_engine_performance_analytics GET /v1/analytics/performance/engine Get Engine Performance
AnalyticsPerformanceApi get_engine_stage_breakdown_analytics_performance GET /v1/analytics/performance/engine/stages Get Engine Stage Breakdown
AnalyticsPerformanceApi get_extractor_breakdown_analytics_performance_engine GET /v1/analytics/performance/engine/extractors Get Extractor Breakdown
AnalyticsPerformanceApi get_slowest_operations_analytics_performance_engine_slow GET /v1/analytics/performance/engine/slow-operations Get Slowest Operations
AnalyticsRetrieversApi analyze_for_tuning_analytics_retrievers POST /v1/analytics/retrievers/{retriever_id}/analyze-tuning Analyze For Tuning
AnalyticsRetrieversApi get_cache_performance_analytics_retrievers GET /v1/analytics/retrievers/{retriever_id}/cache-performance Get Cache Performance
AnalyticsRetrieversApi get_retriever_performance_analytics GET /v1/analytics/retrievers/{retriever_id}/performance Get Retriever Performance
AnalyticsRetrieversApi get_retriever_signals_analytics GET /v1/analytics/retrievers/{retriever_id}/signals Get Retriever Signals
AnalyticsRetrieversApi get_slowest_queries_analytics_retrievers_id_slow GET /v1/analytics/retrievers/{retriever_id}/slow-queries Get Slowest Queries
AnalyticsRetrieversApi get_stage_breakdown_analytics_retrievers GET /v1/analytics/retrievers/{retriever_id}/stages Get Stage Breakdown
AnalyticsTaxonomiesApi get_assignment_metrics_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/assignments Get Assignment Metrics
AnalyticsTaxonomiesApi get_confidence_distribution_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/confidence Get Confidence Distribution
AnalyticsTaxonomiesApi get_enrichment_history_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/enrichments Get Enrichment History
AnalyticsTaxonomiesApi get_label_distribution_analytics_taxonomies_taxonomy GET /v1/analytics/taxonomies/{taxonomy_id}/labels Get Label Distribution
AnalyticsUsageApi get_usage_summary_analytics GET /v1/analytics/usage/summary Get Usage Summary
BucketBatchesApi add_objects_to_batch_buckets_batches POST /v1/buckets/{bucket_identifier}/batches/{batch_id}/objects Add Objects to Batch
BucketBatchesApi cancel_batch_buckets_batches POST /v1/buckets/{bucket_identifier}/batches/{batch_id}/cancel Cancel Batch
BucketBatchesApi create_batch_buckets_batches POST /v1/buckets/{bucket_identifier}/batches Create Batch
BucketBatchesApi delete_batch_buckets_batches DELETE /v1/buckets/{bucket_identifier}/batches/{batch_id} Delete Batch
BucketBatchesApi get_batch_buckets_batches GET /v1/buckets/{bucket_identifier}/batches/{batch_id} Get Batch Configuration
BucketBatchesApi get_batch_logs_buckets_batches GET /v1/buckets/{bucket_identifier}/batches/{batch_id}/logs Get Ray Job Logs for Batch
BucketBatchesApi get_failed_documents_buckets_batches_batch GET /v1/buckets/{bucket_identifier}/batches/{batch_id}/failed-documents Get Failed Documents for Batch
BucketBatchesApi list_batches_buckets POST /v1/buckets/{bucket_identifier}/batches/list List Batches
BucketBatchesApi patch_batch_buckets_batches PATCH /v1/buckets/{bucket_identifier}/batches/{batch_id} Partially Update Batch
BucketBatchesApi retry_batch_buckets_batches POST /v1/buckets/{bucket_identifier}/batches/{batch_id}/retry Retry Failed Documents
BucketBatchesApi retry_qdrant_write_buckets_batches_batch_id_tiers_num POST /v1/buckets/{bucket_identifier}/batches/{batch_id}/tiers/{tier_num}/retry-qdrant-write Retry Qdrant Write from S3
BucketBatchesApi submit_batch_buckets_batches POST /v1/buckets/{bucket_identifier}/batches/{batch_id}/submit Submit Batch for Processing
BucketObjectsApi aggregate_objects_buckets POST /v1/buckets/{bucket_identifier}/objects/aggregate Aggregate Objects
BucketObjectsApi create_object_buckets POST /v1/buckets/{bucket_identifier}/objects Create Object
BucketObjectsApi create_objects_batch_buckets POST /v1/buckets/{bucket_identifier}/objects/batch Create Objects in Batch
BucketObjectsApi delete_object_buckets DELETE /v1/buckets/{bucket_identifier}/objects/{object_identifier} Delete Object
BucketObjectsApi get_object_buckets GET /v1/buckets/{bucket_identifier}/objects/{object_identifier} Get Object
BucketObjectsApi list_objects_buckets POST /v1/buckets/{bucket_identifier}/objects/list List Objects
BucketObjectsApi patch_object_buckets PATCH /v1/buckets/{bucket_identifier}/objects/{object_identifier} Partially Update Object
BucketObjectsApi update_object_buckets PUT /v1/buckets/{bucket_identifier}/objects/{object_identifier} Update Object
BucketSyncsApi create_sync_configuration_buckets POST /v1/buckets/{bucket_id}/syncs Create Sync Configuration
BucketSyncsApi delete_sync_configuration_buckets_id_config DELETE /v1/buckets/{bucket_id}/syncs/{sync_config_id} Delete Sync Configuration
BucketSyncsApi get_sync_configuration_buckets_id_config GET /v1/buckets/{bucket_id}/syncs/{sync_config_id} Get Sync Configuration
BucketSyncsApi list_sync_configurations_buckets POST /v1/buckets/{bucket_id}/syncs/list List Sync Configurations
BucketSyncsApi pause_sync_configuration_buckets_id_config POST /v1/buckets/{bucket_id}/syncs/{sync_config_id}/pause Pause Sync Configuration
BucketSyncsApi resume_sync_configuration_buckets_id_config POST /v1/buckets/{bucket_id}/syncs/{sync_config_id}/resume Resume Sync Configuration
BucketSyncsApi trigger_sync_configuration_buckets_id_config POST /v1/buckets/{bucket_id}/syncs/{sync_config_id}/trigger Trigger Sync Configuration
BucketSyncsApi update_sync_configuration_buckets_id_config PATCH /v1/buckets/{bucket_id}/syncs/{sync_config_id} Update Sync Configuration
BucketTemplatesApi create_bucket_template_from POST /v1/templates/buckets/from-bucket/{bucket_id} Create Bucket Template
BucketTemplatesApi get_bucket_template GET /v1/templates/buckets/{template_id} Get Bucket Template
BucketTemplatesApi instantiate_bucket_template POST /v1/templates/buckets/{template_id}/instantiate Instantiate Bucket Template
BucketTemplatesApi list_bucket_templates POST /v1/templates/buckets List Bucket Templates
BucketUploadsApi confirm_upload_buckets POST /v1/buckets/{bucket_identifier}/uploads/{upload_id}/confirm Confirm Upload
BucketUploadsApi confirm_uploads_batch_buckets POST /v1/buckets/{bucket_identifier}/uploads/confirm/batch Batch Confirm Uploads
BucketUploadsApi create_upload_buckets POST /v1/buckets/{bucket_identifier}/uploads Create Upload
BucketUploadsApi create_uploads_batch_buckets POST /v1/buckets/{bucket_identifier}/uploads/batch Batch Create Uploads
BucketUploadsApi delete_upload_buckets DELETE /v1/buckets/{bucket_identifier}/uploads/{upload_id} Delete Upload
BucketUploadsApi get_upload_buckets GET /v1/buckets/{bucket_identifier}/uploads/{upload_id} Get Upload
BucketUploadsApi list_uploads_buckets POST /v1/buckets/{bucket_identifier}/uploads/list List Uploads
BucketsApi create_bucket POST /v1/buckets Create Bucket
BucketsApi delete_bucket DELETE /v1/buckets/{bucket_identifier} Delete Bucket
BucketsApi get_bucket GET /v1/buckets/{bucket_identifier} Get Bucket
BucketsApi list_buckets POST /v1/buckets/list List Buckets
BucketsApi patch_bucket PATCH /v1/buckets/{bucket_identifier} Partially Update Bucket
BucketsApi update_bucket PUT /v1/buckets/{bucket_identifier} Update Bucket
ClusterExecutionsApi cancel_execution_clusters_id_run POST /v1/clusters/{cluster_id}/executions/{run_id}/cancel Cancel Execution
ClusterExecutionsApi get_cluster_execution GET /v1/clusters/{cluster_id}/executions Get Latest Cluster Execution
ClusterExecutionsApi get_cluster_execution_by_run GET /v1/clusters/{cluster_id}/executions/{run_id} Get Specific Cluster Execution
ClusterExecutionsApi list_cluster_executions POST /v1/clusters/{cluster_id}/executions/list List Cluster Execution History
ClusterTemplatesApi create_cluster_template_from POST /v1/templates/clusters/from-cluster/{cluster_id} Create Cluster Template
ClusterTemplatesApi get_cluster_template GET /v1/templates/clusters/{template_id} Get Cluster Template
ClusterTemplatesApi instantiate_cluster_template POST /v1/templates/clusters/{template_id}/instantiate Instantiate Cluster Template
ClusterTemplatesApi list_cluster_templates POST /v1/templates/clusters List Cluster Templates
ClusterTriggersApi create_trigger_clusters POST /v1/clusters/triggers Create Cluster Trigger
ClusterTriggersApi delete_trigger_clusters DELETE /v1/clusters/triggers/{trigger_id} Delete Cluster Trigger
ClusterTriggersApi get_trigger_clusters GET /v1/clusters/triggers/{trigger_id} Get Cluster Trigger
ClusterTriggersApi get_trigger_history_clusters POST /v1/clusters/triggers/{trigger_id}/history Get Trigger Execution History
ClusterTriggersApi list_triggers_clusters POST /v1/clusters/triggers/list List Cluster Triggers
ClusterTriggersApi pause_trigger_clusters POST /v1/clusters/triggers/{trigger_id}/pause Pause Cluster Trigger
ClusterTriggersApi resume_trigger_clusters POST /v1/clusters/triggers/{trigger_id}/resume Resume Cluster Trigger
ClusterTriggersApi update_trigger_clusters PATCH /v1/clusters/triggers/{trigger_id} Update Cluster Trigger
ClustersApi apply_cluster_enrichment_enrich POST /v1/clusters/enrich Apply Cluster Enrichment
ClustersApi create_cluster POST /v1/clusters Create Cluster
ClustersApi delete_cluster DELETE /v1/clusters/{cluster_id} Delete Cluster
ClustersApi execute_clustering_clusters POST /v1/clusters/{cluster_id}/execute Execute Clustering
ClustersApi get_cluster GET /v1/clusters/{cluster_identifier} Get Cluster
ClustersApi list_clusters POST /v1/clusters/list List Clusters
ClustersApi patch_cluster PATCH /v1/clusters/{cluster_identifier} Partially Update Cluster
CollectionDocumentsApi aggregate_documents POST /v1/collections/{collection_identifier}/documents/aggregate Aggregate Documents
CollectionDocumentsApi batch_delete DELETE /v1/collections/{collection_identifier}/documents/batch Batch Delete Documents
CollectionDocumentsApi batch_update POST /v1/collections/{collection_identifier}/documents/batch Batch Update Documents
CollectionDocumentsApi bulk_update PATCH /v1/collections/{collection_identifier}/documents/bulk Bulk Update Documents
CollectionDocumentsApi create_document POST /v1/collections/{collection_identifier}/documents Create a document.
CollectionDocumentsApi delete_document DELETE /v1/collections/{collection_identifier}/documents/{document_id} Delete a document by ID.
CollectionDocumentsApi get_document GET /v1/collections/{collection_identifier}/documents/{document_id} Get a document by ID.
CollectionDocumentsApi list_documents POST /v1/collections/{collection_identifier}/documents/list List documents.
CollectionDocumentsApi patch_document PATCH /v1/collections/{collection_identifier}/documents/{document_id} Patch Document
CollectionDocumentsApi update_document PUT /v1/collections/{collection_identifier}/documents/{document_id} Update Document
CollectionLifecycleApi get_lifecycle GET /v1/collections/{collection_identifier}/lifecycle Get Lifecycle Status
CollectionLifecycleApi transition_lifecycle PATCH /v1/collections/{collection_identifier}/lifecycle Transition Lifecycle
CollectionSchemaApi sync_collection_schema POST /v1/collections/{collection_id}/sync-schema Sync Collection Schema
CollectionTaxonomiesApi apply_taxonomy_to_collection POST /v1/collections/{collection_identifier}/apply-taxonomy Apply Taxonomy to Existing Documents
CollectionTemplatesApi create_collection_template_from POST /v1/templates/collections/from-collection/{collection_id} Create Collection Template
CollectionTemplatesApi get_collection_template GET /v1/templates/collections/{template_id} Get Collection Template
CollectionTemplatesApi instantiate_collection_template POST /v1/templates/collections/{template_id}/instantiate Instantiate Collection Template
CollectionTemplatesApi list_collection_templates POST /v1/templates/collections List Collection Templates
CollectionsApi clone_collection POST /v1/collections/{collection_identifier}/clone Clone Collection
CollectionsApi create_collection POST /v1/collections Create Collection
CollectionsApi delete_collection DELETE /v1/collections/{collection_identifier} Delete Collection
CollectionsApi describe_collection_features GET /v1/collections/{collection_identifier}/features Describe collection features
CollectionsApi export_collection POST /v1/collections/{collection_identifier}/export Export Collection
CollectionsApi get_collection GET /v1/collections/{collection_identifier} Get Collection
CollectionsApi list_collections POST /v1/collections/list List Collections
CollectionsApi trigger_collection POST /v1/collections/{collection_identifier}/trigger Trigger Collection Processing
CollectionsApi update_collection PATCH /v1/collections/{collection_identifier} Update Collection
CustomModelsApi delete_model_namespaces DELETE /v1/namespaces/{namespace_id}/models/{model_id} Delete a model
CustomModelsApi deploy_model_namespaces POST /v1/namespaces/{namespace_id}/models/{model_id}/deploy Deploy model to Ray object store
CustomModelsApi disable_org_model_namespaces POST /v1/namespaces/{namespace_id}/models/org/{model_id}/disable Disable org model for namespace
CustomModelsApi enable_org_model_namespaces POST /v1/namespaces/{namespace_id}/models/org/{model_id}/enable Enable org model for namespace
CustomModelsApi get_model_namespaces GET /v1/namespaces/{namespace_id}/models/{model_id} Get model details
CustomModelsApi list_available_org_models_namespaces GET /v1/namespaces/{namespace_id}/models/available List available org models
CustomModelsApi list_models_namespaces GET /v1/namespaces/{namespace_id}/models List models in namespace
CustomModelsApi upload_model_namespaces POST /v1/namespaces/{namespace_id}/models Upload a custom model
CustomPluginsNamespaceApi confirm_upload_namespaces_id_plugins POST /v1/namespaces/{namespace_id}/plugins/uploads/{upload_id}/confirm Confirm plugin upload
CustomPluginsNamespaceApi delete_plugin_namespaces DELETE /v1/namespaces/{namespace_id}/plugins/{plugin_id} Delete a plugin
CustomPluginsNamespaceApi deploy_plugin_namespaces POST /v1/namespaces/{namespace_id}/plugins/{plugin_id}/deploy Deploy or redeploy a plugin
CustomPluginsNamespaceApi disable_org_plugin_namespaces POST /v1/namespaces/{namespace_id}/plugins/org/{plugin_id}/disable Disable org plugin for namespace
CustomPluginsNamespaceApi enable_org_plugin_namespaces POST /v1/namespaces/{namespace_id}/plugins/org/{plugin_id}/enable Enable org plugin for namespace
CustomPluginsNamespaceApi generate_upload_url_namespaces_id_plugins POST /v1/namespaces/{namespace_id}/plugins/uploads Generate presigned URL for plugin upload
CustomPluginsNamespaceApi get_deployment_status_namespaces_id_plugins GET /v1/namespaces/{namespace_id}/plugins/{plugin_id}/status Get plugin deployment status
CustomPluginsNamespaceApi get_plugin_namespaces GET /v1/namespaces/{namespace_id}/plugins/{plugin_id} Get plugin details
CustomPluginsNamespaceApi list_available_org_plugins_namespaces GET /v1/namespaces/{namespace_id}/plugins/available List available org plugins
CustomPluginsNamespaceApi list_plugins_namespaces GET /v1/namespaces/{namespace_id}/plugins List plugins in namespace
CustomPluginsNamespaceApi reconfigure_namespace_id_plugins POST /v1/namespaces/{namespace_id}/plugins/reconfigure Reconfigure namespace Qdrant schema
CustomPluginsNamespaceApi test_realtime_inference_namespaces_id_plugins POST /v1/namespaces/{namespace_id}/plugins/{plugin_id}/realtime/test Test plugin realtime inference
CustomPluginsNamespaceApi undeploy_plugin_namespaces POST /v1/namespaces/{namespace_id}/plugins/{plugin_id}/undeploy Undeploy a plugin
CustomPluginsNamespaceApi upload_plugin_namespaces POST /v1/namespaces/{namespace_id}/plugins Upload a custom plugin
DiscoveryApi get_all_discovery GET /v1/discovery Get All Discovery Information
DiscoveryApi get_manifest_schema_discovery GET /v1/discovery/schema Get Manifest Schema for Agent Configuration
DiscoveryApi list_extractors_discovery GET /v1/discovery/extractors List Available Feature Extractors
DiscoveryApi list_stages_with_examples_discovery GET /v1/discovery/stages List Available Retriever Stages with Examples
DocumentLineageApi get_decomposition_tree_objects GET /v1/objects/{object_id}/decomposition-tree Get decomposition tree visualization
DocumentLineageApi get_document_lineage GET /v1/collections/{collection_id}/documents/{document_id}/lineage Get document lineage
DocumentLineageApi get_documents_by_object GET /v1/objects/{object_id}/documents Get all documents derived from an object
DocumentsApi get_document_ns GET /v1/documents/{document_id} Get a document by ID (namespace-scoped).
DocumentsApi patch_document_ns PATCH /v1/documents/{document_id} Partially update a document by ID (namespace-scoped).
DocumentsApi update_document_ns PUT /v1/documents/{document_id} Update a document by ID (namespace-scoped).
EvaluationDatasetsApi create_dataset_retrievers_evaluations POST /v1/retrievers/evaluations/datasets Create evaluation dataset
EvaluationDatasetsApi get_dataset_retrievers_evaluations GET /v1/retrievers/evaluations/datasets/{dataset_identifier} Get evaluation dataset
EvaluationDatasetsApi list_datasets_retrievers_evaluations GET /v1/retrievers/evaluations/datasets List evaluation datasets
EvaluationsApi get_evaluation_retrievers GET /v1/retrievers/{retriever_id}/evaluations/{evaluation_id} Get evaluation results
EvaluationsApi list_evaluations_retrievers GET /v1/retrievers/{retriever_id}/evaluations List evaluations
EvaluationsApi start_evaluation_retrievers POST /v1/retrievers/{retriever_id}/evaluations Run evaluation
FeatureExtractorsApi get_feature_extractor_by GET /v1/collections/features/extractors/{feature_extractor_id} Get Feature Extractor by Name
FeatureExtractorsApi list_feature_extractors GET /v1/collections/features/extractors List Feature Extractors
HealthApi celery_beat_health GET /v1/health/beat Celery Beat Health
HealthApi celery_beat_health_0 GET /v1/health/beat Celery Beat Health
HealthApi healthcheck_health GET /v1/health Healthcheck
HealthApi healthcheck_health_0 GET /v1/health Healthcheck
HealthApi liveness_health GET /v1/health/liveness Liveness
HealthApi liveness_health_0 GET /v1/health/liveness Liveness
InferenceApi execute_raw_inference POST /v1/inference Execute Raw Inference
ManifestApi apply_manifest POST /v1/manifest/apply Apply Manifest
ManifestApi diff_manifest POST /v1/manifest/diff Diff Manifest
ManifestApi export_manifest_get GET /v1/manifest/export Export Manifest Get
ManifestApi export_manifest_post POST /v1/manifest/export Export Manifest Post
ManifestApi generate_manifest POST /v1/manifest/generate Generate Manifest
ManifestApi lint_manifest POST /v1/manifest/lint Lint Manifest
ManifestApi validate_manifest POST /v1/manifest/validate Validate Manifest
MarketplaceApi cancel_subscription_marketplace DELETE /v1/marketplace/subscriptions/{subscription_id} Cancel Subscription
MarketplaceApi create_marketplace_listing POST /v1/marketplace/listings Create Marketplace Listing
MarketplaceApi create_subscription_marketplace POST /v1/marketplace/subscriptions Subscribe to Marketplace Listing
MarketplaceApi delete_marketplace_listing DELETE /v1/marketplace/listings/{listing_id} Delete Marketplace Listing
MarketplaceApi execute_marketplace_retriever_catalog_name POST /v1/marketplace/catalog/{public_name}/execute Execute Marketplace Retriever
MarketplaceApi get_marketplace_catalog GET /v1/marketplace/catalog Browse Marketplace Catalog
MarketplaceApi get_marketplace_listing_by_name_catalog GET /v1/marketplace/catalog/{public_name} Get Marketplace Listing by Public Name
MarketplaceApi get_marketplace_listing_config_catalog_name GET /v1/marketplace/catalog/{public_name}/config Get Marketplace Listing Configuration
MarketplaceApi get_marketplace_listing_template_catalog_name GET /v1/marketplace/catalog/{public_name}/template Get Marketplace Listing as Template
MarketplaceApi get_subscription_marketplace GET /v1/marketplace/subscriptions/{subscription_id} Get Subscription Details
MarketplaceApi list_my_subscriptions_marketplace GET /v1/marketplace/subscriptions List My Subscriptions
MarketplaceApi publish_marketplace_listing PATCH /v1/marketplace/listings/{listing_id}/publish Publish Marketplace Listing
MarketplaceApi update_marketplace_listing PATCH /v1/marketplace/listings/{listing_id} Update Marketplace Listing
MarketplaceApi verify_marketplace_listing_password_catalog_name POST /v1/marketplace/catalog/{public_name}/verify Verify Password for Marketplace Listing
ModelsApi confirm_upload_models POST /v1/models/uploads/{upload_id}/confirm Confirm model upload
ModelsApi delete_model DELETE /v1/models/{model_id} Delete model
ModelsApi generate_upload_url_models POST /v1/models/uploads Generate presigned URL for model upload
ModelsApi get_model GET /v1/models/{model_id} Get model details
ModelsApi list_models GET /v1/models List organization models
NamespaceCloneApi clone_namespace POST /v1/namespaces/{namespace_identifier}/clone Clone Namespace
NamespaceExtractorsApi get_extractor_namespaces GET /v1/namespaces/{namespace_id}/extractors/{extractor_id} Get extractor details
NamespaceExtractorsApi list_extractors_namespaces GET /v1/namespaces/{namespace_id}/extractors List all extractors available to namespace
NamespaceMigrationsApi cancel_migration_namespaces POST /v1/namespaces/migrations/{migration_id}/cancel Cancel Migration
NamespaceMigrationsApi create_migration_namespaces POST /v1/namespaces/migrations/ Create Migration
NamespaceMigrationsApi delete_migration_namespaces DELETE /v1/namespaces/migrations/{migration_id} Delete Migration
NamespaceMigrationsApi get_migration_namespaces GET /v1/namespaces/migrations/{migration_id} Get Migration
NamespaceMigrationsApi list_migrations_namespaces POST /v1/namespaces/migrations/list List Migrations
NamespaceMigrationsApi start_migration_namespaces POST /v1/namespaces/migrations/{migration_id}/start Start Migration
NamespaceMigrationsApi validate_migration_namespaces POST /v1/namespaces/migrations/validate Validate Migration
NamespaceTemplatesApi create_namespace_template_from POST /v1/templates/namespaces/from-namespace/{namespace_id} Create Namespace Template
NamespaceTemplatesApi get_namespace_template GET /v1/templates/namespaces/{template_id} Get Namespace Template
NamespaceTemplatesApi instantiate_namespace_template POST /v1/templates/namespaces/{template_id}/instantiate Instantiate Namespace Template
NamespaceTemplatesApi list_namespace_templates GET /v1/templates/namespaces List Namespace Templates
NamespacesApi create_namespace POST /v1/namespaces Create Namespace
NamespacesApi delete_namespace DELETE /v1/namespaces/{namespace_identifier} Delete Namespace
NamespacesApi get_namespace GET /v1/namespaces/{namespace_identifier} Get Namespace
NamespacesApi list_namespaces POST /v1/namespaces/list List Namespaces
NamespacesApi patch_namespace PATCH /v1/namespaces/{namespace_identifier} Partially Update Namespace
NamespacesApi update_namespace PUT /v1/namespaces/{namespace_identifier} Update Namespace
NotificationsApi delete_notification DELETE /v1/notifications/{notification_id} Delete Notification
NotificationsApi get_funnel_state_notifications GET /v1/notifications/funnel/state Get Funnel State
NotificationsApi get_notification GET /v1/notifications/{notification_id} Get Notification
NotificationsApi get_preferences_notifications GET /v1/notifications/preferences Get Preferences
NotificationsApi get_reminder_preferences_notifications GET /v1/notifications/preferences/reminders Get Reminder Preferences
NotificationsApi get_unread_count_notifications GET /v1/notifications/unread/count Get Unread Count
NotificationsApi list_notifications POST /v1/notifications/list List Notifications
NotificationsApi mark_all_as_read_notifications POST /v1/notifications/read/all Mark All As Read
NotificationsApi mark_as_read_notifications POST /v1/notifications/{notification_id}/read Mark As Read
NotificationsApi update_preferences_notifications PUT /v1/notifications/preferences Update Preferences
NotificationsApi update_reminder_preferences_notifications PUT /v1/notifications/preferences/reminders Update Reminder Preferences
OrganizationAPIKeysApi create_key_organizations_users_email POST /v1/organizations/users/{user_email}/api-keys Create Api Key
OrganizationAPIKeysApi delete_key_organizations_users_email_name DELETE /v1/organizations/users/{user_email}/api-keys/{key_name} Delete Api Key
OrganizationAPIKeysApi list_keys_organizations_users_email GET /v1/organizations/users/{user_email}/api-keys List Api Keys
OrganizationAPIKeysApi rotate_key_organizations_users_email_name POST /v1/organizations/users/{user_email}/api-keys/{key_name}/rotate Rotate Api Key
OrganizationAPIKeysApi update_key_organizations_users_email_name PATCH /v1/organizations/users/{user_email}/api-keys/{key_name} Update Api Key
OrganizationAuditApi get_audit_log_organizations GET /v1/organizations/audit/logs/{audit_id} Get Audit Log
OrganizationAuditApi get_audit_settings_organizations GET /v1/organizations/audit/settings Get Audit Settings
OrganizationAuditApi list_audit_logs_organizations GET /v1/organizations/audit/logs List Audit Logs
OrganizationAuditApi update_audit_settings_organizations PATCH /v1/organizations/audit/settings Update Audit Settings
OrganizationBillingApi confirm_payment_method_organizations_billing POST /v1/organizations/billing/confirm-payment-method Confirm Payment Method
OrganizationBillingApi disable_auto_billing_organizations POST /v1/organizations/billing/disable-auto-billing Disable Auto Billing
OrganizationBillingApi enable_auto_billing_organizations POST /v1/organizations/billing/enable-auto-billing Enable Auto Billing
OrganizationBillingApi generate_invoice_now_organizations_billing POST /v1/organizations/billing/generate-invoice Generate Invoice Now
OrganizationBillingApi get_credit_balance_organizations_billing GET /v1/organizations/billing/balance Get Credit Balance
OrganizationBillingApi get_current_usage_organizations_billing GET /v1/organizations/billing/usage/current Get Current Usage
OrganizationBillingApi get_payment_method_organizations_billing GET /v1/organizations/billing/payment-method Get Payment Method
OrganizationBillingApi get_spending_caps_organizations_billing GET /v1/organizations/billing/spending-caps Get Spending Caps
OrganizationBillingApi get_usage_breakdown_organizations_billing GET /v1/organizations/billing/usage/breakdown Get Usage Breakdown
OrganizationBillingApi list_invoices_organizations_billing GET /v1/organizations/billing/invoices List Invoices
OrganizationBillingApi setup_payment_method_organizations_billing POST /v1/organizations/billing/setup-payment-method Setup Payment Method
OrganizationBillingApi update_spending_caps_organizations_billing POST /v1/organizations/billing/spending-caps Update Spending Caps
OrganizationConnectionsApi create_storage_connection_organizations POST /v1/organizations/connections Create Storage Connection
OrganizationConnectionsApi delete_storage_connection_organizations DELETE /v1/organizations/connections/{connection_identifier} Delete Storage Connection
OrganizationConnectionsApi get_storage_connection_organizations GET /v1/organizations/connections/{connection_identifier} Get Storage Connection
OrganizationConnectionsApi list_google_drive_files_organizations_connections GET /v1/organizations/connections/{connection_identifier}/files List Google Drive Files
OrganizationConnectionsApi list_google_drive_folders_organizations_connections GET /v1/organizations/connections/{connection_identifier}/folders List Google Drive Folders
OrganizationConnectionsApi list_storage_connections_organizations POST /v1/organizations/connections/list List Storage Connections
OrganizationConnectionsApi test_storage_connection_organizations POST /v1/organizations/connections/{connection_identifier}/test Test Storage Connection
OrganizationConnectionsApi update_storage_connection_organizations PATCH /v1/organizations/connections/{connection_identifier} Update Storage Connection
OrganizationSecretsApi create_secret_organizations POST /v1/organizations/secrets Create Secret
OrganizationSecretsApi delete_secret_organizations_name DELETE /v1/organizations/secrets/{secret_name} Delete Secret
OrganizationSecretsApi list_secrets_organizations GET /v1/organizations/secrets List Secrets
OrganizationSecretsApi update_secret_organizations_name PUT /v1/organizations/secrets/{secret_name} Update Secret
OrganizationUsageApi get_key_breakdown_organizations_id_usage_endpoints GET /v1/organizations/api-keys/{key_id}/usage/endpoints Get Api Key Endpoint Breakdown
OrganizationUsageApi get_key_usage_organizations GET /v1/organizations/api-keys/{key_id}/usage Get Api Key Usage
OrganizationUsageApi get_org_usage_organizations GET /v1/organizations/usage Get Org Usage
OrganizationUsersApi create_user_organizations POST /v1/organizations/users Create User
OrganizationUsersApi delete_user_organizations_email DELETE /v1/organizations/users/{user_email} Delete User
OrganizationUsersApi get_user_organizations_email GET /v1/organizations/users/{user_email} Get User
OrganizationUsersApi list_users_organizations GET /v1/organizations/users List Users
OrganizationUsersApi update_user_organizations_email PATCH /v1/organizations/users/{user_email} Update User
OrganizationsApi add_credits_organizations POST /v1/organizations/credits Add Credits
OrganizationsApi get_organization GET /v1/organizations Get Organization
OrganizationsApi update_organization PATCH /v1/organizations Update Organization
PagesApi create_page POST /v1/pages Create a Page
PagesApi delete_page DELETE /v1/pages/{page_id} Delete a Page
PagesApi get_page GET /v1/pages/{page_id} Get a Page
PagesApi list_pages GET /v1/pages List Pages
PagesApi update_page PATCH /v1/pages/{page_id} Update a Page
PluginsApi confirm_upload_plugins POST /v1/plugins/uploads/{upload_id}/confirm Confirm plugin upload
PluginsApi delete_plugin DELETE /v1/plugins/{plugin_id} Delete a plugin
PluginsApi generate_upload_url_plugins POST /v1/plugins/uploads Generate presigned URL for plugin upload
PluginsApi get_plugin GET /v1/plugins/{plugin_id} Get plugin details
PluginsApi list_plugins GET /v1/plugins List plugins in organization
PrivateApi accept_invitation_organizations POST /v1/private/organizations/invitations/accept Accept Invitation
PrivateApi add_user_to_organization POST /v1/private/organizations/add-user Add User To Organization Private
PrivateApi complete_tier_internal_batches_batch_id_num POST /v1/internal/batches/{batch_id}/tiers/{tier_num}/complete Mark tier complete and trigger next tier (KISS - Engine callback)
PrivateApi configure_storage_cors_configurations POST /v1/private/configurations/storage/cors Configure CORS for Object Storage
PrivateApi create_bootstrap_key_organizations_id_users_email POST /v1/private/organizations/{organization_id}/users/{user_email}/bootstrap-key Create Bootstrap Api Key
PrivateApi create_organization POST /v1/private/organizations Create Organization Private
PrivateApi delete_organization DELETE /v1/private/organizations/{organization_identifier} Delete Organization Private
PrivateApi diagnose_clickhouse_configurations_diagnostics GET /v1/private/configurations/clickhouse/diagnostics Diagnose ClickHouse Configuration
PrivateApi get_organization GET /v1/private/organizations/{organization_identifier} Get Organization Private
PrivateApi get_pending_invitations_organizations_email GET /v1/private/organizations/invitations/{email} Get Pending Invitations
PrivateApi get_storage_cors_configurations GET /v1/private/configurations/storage/cors Get Current CORS Configuration
PrivateApi remove_user_from_organization POST /v1/private/organizations/remove-user Remove User From Organization Private
PrivateApi update_organization PATCH /v1/private/organizations/{organization_identifier} Update Organization Private
PrivateApi update_task_status_internal POST /v1/internal/tasks/{task_id}/status Update task status (Engine callback)
PublicNotificationsAPIApi unsubscribe_from_nudges_notifications GET /v1/public/notifications/unsubscribe Unsubscribe From Nudges
PublicPagesAPIApi execute_page_search_slug POST /v1/public/pages/{slug}/search Execute a Page tab search
PublicPagesAPIApi get_page_config_slug GET /v1/public/pages/{slug} Get public Page config
PublicPagesAPIApi get_page_gallery_slug GET /v1/public/pages/{slug}/gallery Get Page featured gallery
PublicRetrieverAPIApi execute_retriever_name POST /v1/public/retrievers/{public_name}/execute Execute Public Retriever
PublicRetrieverAPIApi get_retriever_config_name GET /v1/public/retrievers/{public_name}/config Get Public Retriever Config
PublicRetrieverAPIApi get_retriever_template_name GET /v1/public/retrievers/{public_name}/template Get Public Retriever Template
PublicRetrieverAPIApi list_retrievers GET /v1/public/retrievers/ List Public Retrievers
PublicRetrieverAPIApi track_interaction_batch_retrievers_name POST /v1/public/retrievers/{public_name}/interactions/batch Track Interaction Batch
PublicRetrieverAPIApi track_interaction_retrievers_name POST /v1/public/retrievers/{public_name}/interactions Track Interaction
PublicRetrieverAPIApi verify_password_retrievers_name POST /v1/public/retrievers/{public_name}/verify Verify Password
PublicScaffoldsApi get_scaffold_templates GET /v1/public/templates/scaffolds/{template_id} Get Scaffold
PublicScaffoldsApi list_scaffolds_templates GET /v1/public/templates/scaffolds List Scaffolds
PublicTemplatesAPIApi get_namespace_template GET /v1/public/templates/namespaces/{template_id} Get Public Namespace Template
PublicTemplatesAPIApi get_retriever_template GET /v1/public/templates/retrievers/{template_id} Get Public Retriever Template
PublicTemplatesAPIApi get_scaffold_templates GET /v1/public/templates/scaffolds/{template_id} Get Scaffold
PublicTemplatesAPIApi list_namespace_templates GET /v1/public/templates/namespaces List Public Namespace Templates
PublicTemplatesAPIApi list_retriever_templates GET /v1/public/templates/retrievers List Public Retriever Templates
PublicTemplatesAPIApi list_scaffolds_templates GET /v1/public/templates/scaffolds List Scaffolds
PublishedRetrieversApi check_name_availability_retrievers_id_publish GET /v1/retrievers/{retriever_id}/publish/availability Check Name Availability
PublishedRetrieversApi get_organization_publish_stats_retrievers GET /v1/retrievers/publish/stats Get Organization Publish Stats
PublishedRetrieversApi get_published_retriever_id_publish GET /v1/retrievers/{retriever_id}/publish Get Published Retriever
PublishedRetrieversApi list_published_retrievers GET /v1/retrievers/published List Published Retrievers
PublishedRetrieversApi publish_retriever POST /v1/retrievers/{retriever_id}/publish Publish Retriever
PublishedRetrieversApi unpublish_retriever_id_publish DELETE /v1/retrievers/{retriever_id}/publish Unpublish Retriever
PublishedRetrieversApi update_published_retriever_id_publish PATCH /v1/retrievers/{retriever_id}/publish Update Published Retriever
QuickstartApi provision_docs_search_quickstart POST /v1/quickstart/docs-search Provision Docs Search
ResourceSearchApi search_resources POST /v1/resources/search Search Resources
RetrieverAPIKeysApi create_retriever_key POST /v1/retrievers/{retriever_id}/api-keys Create Retriever API Key
RetrieverAPIKeysApi list_retriever_keys GET /v1/retrievers/{retriever_id}/api-keys List Retriever API Keys
RetrieverAPIKeysApi revoke_retriever_key DELETE /v1/retrievers/{retriever_id}/api-keys/{key_id} Revoke Retriever API Key
RetrieverBenchmarksApi create_benchmark_retrievers POST /v1/retrievers/benchmarks Create benchmark
RetrieverBenchmarksApi create_benchmark_retrievers_0 POST /v1/retrievers/benchmarks Create benchmark
RetrieverBenchmarksApi delete_benchmark_retrievers DELETE /v1/retrievers/benchmarks/{benchmark_id} Delete benchmark
RetrieverBenchmarksApi delete_benchmark_retrievers_0 DELETE /v1/retrievers/benchmarks/{benchmark_id} Delete benchmark
RetrieverBenchmarksApi get_benchmark_retrievers GET /v1/retrievers/benchmarks/{benchmark_id} Get benchmark
RetrieverBenchmarksApi get_benchmark_retrievers_0 GET /v1/retrievers/benchmarks/{benchmark_id} Get benchmark
RetrieverBenchmarksApi list_benchmarks_retrievers GET /v1/retrievers/benchmarks List benchmarks
RetrieverBenchmarksApi list_benchmarks_retrievers_0 GET /v1/retrievers/benchmarks List benchmarks
RetrieverEvaluationsApi create_dataset_retrievers_evaluations POST /v1/retrievers/evaluations/datasets Create evaluation dataset
RetrieverEvaluationsApi get_dataset_retrievers_evaluations GET /v1/retrievers/evaluations/datasets/{dataset_identifier} Get evaluation dataset
RetrieverEvaluationsApi get_evaluation_retrievers GET /v1/retrievers/{retriever_id}/evaluations/{evaluation_id} Get evaluation results
RetrieverEvaluationsApi list_datasets_retrievers_evaluations GET /v1/retrievers/evaluations/datasets List evaluation datasets
RetrieverEvaluationsApi list_evaluations_retrievers GET /v1/retrievers/{retriever_id}/evaluations List evaluations
RetrieverEvaluationsApi start_evaluation_retrievers POST /v1/retrievers/{retriever_id}/evaluations Run evaluation
RetrieverInteractionsApi create_interaction_retrievers POST /v1/retrievers/interactions Create Interaction
RetrieverInteractionsApi delete_interaction_retrievers DELETE /v1/retrievers/interactions/{interaction_id} Delete Interaction
RetrieverInteractionsApi get_interaction_retrievers GET /v1/retrievers/interactions/{interaction_id} Get Interaction
RetrieverInteractionsApi list_interactions_retrievers POST /v1/retrievers/interactions/list List Interactions
RetrieverStagesApi list_stages_retrievers GET /v1/retrievers/stages List Available Retriever Stages
RetrieverTemplatesApi create_retriever_template_from POST /v1/templates/retrievers/from-retriever/{retriever_id} Create Retriever Template
RetrieverTemplatesApi get_retriever_template GET /v1/templates/retrievers/{template_id} Get Retriever Template
RetrieverTemplatesApi instantiate_retriever_template POST /v1/templates/retrievers/{template_id}/instantiate Instantiate Retriever Template
RetrieverTemplatesApi list_retriever_templates POST /v1/templates/retrievers List Retriever Templates
RetrieversApi clone_retriever POST /v1/retrievers/{retriever_id}/clone Clone Retriever
RetrieversApi create_retriever POST /v1/retrievers Create Retriever
RetrieversApi delete_retriever DELETE /v1/retrievers/{retriever_id} Delete Retriever
RetrieversApi execute_retriever POST /v1/retrievers/{retriever_id}/execute Execute Retriever (Auto-Optimized)
RetrieversApi explain_retriever_execution_id_execute POST /v1/retrievers/{retriever_id}/execute/explain Explain Retriever Execution Plan
RetrieversApi get_execution_retrievers GET /v1/retrievers/{retriever_id}/executions/{execution_id} Get Execution
RetrieversApi get_retriever GET /v1/retrievers/{retriever_id} Get Retriever
RetrieversApi list_executions_retrievers POST /v1/retrievers/{retriever_id}/executions/list List Executions
RetrieversApi list_retrievers POST /v1/retrievers/list List Retrievers
RetrieversApi list_retrievers_get GET /v1/retrievers List Retrievers Get
RetrieversApi patch_retriever PATCH /v1/retrievers/{retriever_id} Patch Retriever
ScaffoldTemplatesApi instantiate_scaffold_template POST /v1/templates/scaffolds/{template_id}/instantiate Instantiate Scaffold Template
TasksApi get_task GET /v1/tasks/{task_id} Get Task Information
TasksApi kill_task DELETE /v1/tasks/{task_id} Kill Task
TasksApi list_tasks POST /v1/tasks/list List Tasks
TaxonomiesApi clone_taxonomy_taxonomies POST /v1/taxonomies/{taxonomy_identifier}/clone Clone Taxonomy
TaxonomiesApi create_taxonomy_taxonomies POST /v1/taxonomies Create Taxonomy
TaxonomiesApi create_taxonomy_version_taxonomies POST /v1/taxonomies/{taxonomy_id}/versions Create Taxonomy Version
TaxonomiesApi delete_taxonomy_taxonomies DELETE /v1/taxonomies/{taxonomy_identifier} Delete Taxonomy
TaxonomiesApi execute_taxonomy_taxonomies POST /v1/taxonomies/execute/{taxonomy_identifier} Test taxonomy configuration (validation only)
TaxonomiesApi get_taxonomy_taxonomies GET /v1/taxonomies/{taxonomy_identifier} Get Taxonomy
TaxonomiesApi list_taxonomies POST /v1/taxonomies/list List Taxonomies
TaxonomiesApi list_taxonomy_versions_taxonomies GET /v1/taxonomies/{taxonomy_id}/versions List Taxonomy Versions
TaxonomiesApi patch_taxonomy_taxonomies PATCH /v1/taxonomies/{taxonomy_identifier} Partially Update Taxonomy
TaxonomyAnalyticsApi analyze_transition_paths_taxonomies_taxonomy_id_analytics POST /v1/taxonomies/{taxonomy_id}/analytics/paths Analyze multi-step transition paths
TaxonomyAnalyticsApi analyze_transition_paths_taxonomies_taxonomy_id_analytics_0 POST /v1/taxonomies/{taxonomy_id}/analytics/paths Analyze multi-step transition paths
TaxonomyAnalyticsApi compute_step_transitions_taxonomies_taxonomy_id_analytics POST /v1/taxonomies/{taxonomy_id}/analytics/transitions Compute step transition analytics
TaxonomyAnalyticsApi compute_step_transitions_taxonomies_taxonomy_id_analytics_0 POST /v1/taxonomies/{taxonomy_id}/analytics/transitions Compute step transition analytics
TaxonomyAnalyticsApi get_available_steps_taxonomies_taxonomy_id_analytics GET /v1/taxonomies/{taxonomy_id}/analytics/available-steps Get Available Steps
TaxonomyAnalyticsApi get_available_steps_taxonomies_taxonomy_id_analytics_0 GET /v1/taxonomies/{taxonomy_id}/analytics/available-steps Get Available Steps
TaxonomyTemplatesApi create_taxonomy_template_taxonomies_from POST /v1/templates/taxonomies/from-taxonomy/{taxonomy_id} Create Taxonomy Template
TaxonomyTemplatesApi get_taxonomy_template_taxonomies GET /v1/templates/taxonomies/{template_id} Get Taxonomy Template
TaxonomyTemplatesApi instantiate_taxonomy_template_taxonomies POST /v1/templates/taxonomies/{template_id}/instantiate Instantiate Taxonomy Template
TaxonomyTemplatesApi list_taxonomy_templates_taxonomies POST /v1/templates/taxonomies List Taxonomy Templates
TemplatesApi create_bucket_template_from POST /v1/templates/buckets/from-bucket/{bucket_id} Create Bucket Template
TemplatesApi create_cluster_template_from POST /v1/templates/clusters/from-cluster/{cluster_id} Create Cluster Template
TemplatesApi create_collection_template_from POST /v1/templates/collections/from-collection/{collection_id} Create Collection Template
TemplatesApi create_namespace_template_from POST /v1/templates/namespaces/from-namespace/{namespace_id} Create Namespace Template
TemplatesApi create_retriever_template_from POST /v1/templates/retrievers/from-retriever/{retriever_id} Create Retriever Template
TemplatesApi create_taxonomy_template_taxonomies_from POST /v1/templates/taxonomies/from-taxonomy/{taxonomy_id} Create Taxonomy Template
TemplatesApi get_bucket_template GET /v1/templates/buckets/{template_id} Get Bucket Template
TemplatesApi get_cluster_template GET /v1/templates/clusters/{template_id} Get Cluster Template
TemplatesApi get_collection_template GET /v1/templates/collections/{template_id} Get Collection Template
TemplatesApi get_namespace_template GET /v1/templates/namespaces/{template_id} Get Namespace Template
TemplatesApi get_retriever_template GET /v1/templates/retrievers/{template_id} Get Retriever Template
TemplatesApi get_taxonomy_template_taxonomies GET /v1/templates/taxonomies/{template_id} Get Taxonomy Template
TemplatesApi instantiate_bucket_template POST /v1/templates/buckets/{template_id}/instantiate Instantiate Bucket Template
TemplatesApi instantiate_cluster_template POST /v1/templates/clusters/{template_id}/instantiate Instantiate Cluster Template
TemplatesApi instantiate_collection_template POST /v1/templates/collections/{template_id}/instantiate Instantiate Collection Template
TemplatesApi instantiate_namespace_template POST /v1/templates/namespaces/{template_id}/instantiate Instantiate Namespace Template
TemplatesApi instantiate_retriever_template POST /v1/templates/retrievers/{template_id}/instantiate Instantiate Retriever Template
TemplatesApi instantiate_taxonomy_template_taxonomies POST /v1/templates/taxonomies/{template_id}/instantiate Instantiate Taxonomy Template
TemplatesApi list_bucket_templates POST /v1/templates/buckets List Bucket Templates
TemplatesApi list_cluster_templates POST /v1/templates/clusters List Cluster Templates
TemplatesApi list_collection_templates POST /v1/templates/collections List Collection Templates
TemplatesApi list_namespace_templates GET /v1/templates/namespaces List Namespace Templates
TemplatesApi list_retriever_templates POST /v1/templates/retrievers List Retriever Templates
TemplatesApi list_taxonomy_templates_taxonomies POST /v1/templates/taxonomies List Taxonomy Templates
WebhooksApi create_webhook_organizations POST /v1/organizations/webhooks/ Create Webhook
WebhooksApi delete_webhook_organizations DELETE /v1/organizations/webhooks/{identifier} Delete Webhook
WebhooksApi get_webhook_organizations GET /v1/organizations/webhooks/{identifier} Get Webhook
WebhooksApi list_webhooks_organizations POST /v1/organizations/webhooks/list List Webhooks
WebhooksApi update_webhook_organizations PUT /v1/organizations/webhooks/{identifier} Update Webhook
DefaultApi create_trigger POST /v1/triggers Create Trigger
DefaultApi delete_trigger DELETE /v1/triggers/{trigger_id} Delete Trigger
DefaultApi execute_trigger_now POST /v1/triggers/{trigger_id}/execute Execute Trigger Now
DefaultApi get_trigger GET /v1/triggers/{trigger_id} Get Trigger
DefaultApi get_trigger_history GET /v1/triggers/{trigger_id}/history Get Trigger Execution History
DefaultApi list_triggers POST /v1/triggers/list List Triggers
DefaultApi pause_trigger POST /v1/triggers/{trigger_id}/pause Pause Trigger
DefaultApi resume_trigger POST /v1/triggers/{trigger_id}/resume Resume Trigger
DefaultApi update_trigger PATCH /v1/triggers/{trigger_id} Update Trigger
MarketplaceApi cancel_subscription_marketplace DELETE /v1/marketplace/subscriptions/{subscription_id} Cancel Subscription
MarketplaceApi create_marketplace_listing POST /v1/marketplace/listings Create Marketplace Listing
MarketplaceApi create_subscription_marketplace POST /v1/marketplace/subscriptions Subscribe to Marketplace Listing
MarketplaceApi delete_marketplace_listing DELETE /v1/marketplace/listings/{listing_id} Delete Marketplace Listing
MarketplaceApi execute_marketplace_retriever_catalog_name POST /v1/marketplace/catalog/{public_name}/execute Execute Marketplace Retriever
MarketplaceApi get_marketplace_catalog GET /v1/marketplace/catalog Browse Marketplace Catalog
MarketplaceApi get_marketplace_listing_by_name_catalog GET /v1/marketplace/catalog/{public_name} Get Marketplace Listing by Public Name
MarketplaceApi get_marketplace_listing_config_catalog_name GET /v1/marketplace/catalog/{public_name}/config Get Marketplace Listing Configuration
MarketplaceApi get_marketplace_listing_template_catalog_name GET /v1/marketplace/catalog/{public_name}/template Get Marketplace Listing as Template
MarketplaceApi get_subscription_marketplace GET /v1/marketplace/subscriptions/{subscription_id} Get Subscription Details
MarketplaceApi list_my_subscriptions_marketplace GET /v1/marketplace/subscriptions List My Subscriptions
MarketplaceApi publish_marketplace_listing PATCH /v1/marketplace/listings/{listing_id}/publish Publish Marketplace Listing
MarketplaceApi update_marketplace_listing PATCH /v1/marketplace/listings/{listing_id} Update Marketplace Listing
MarketplaceApi verify_marketplace_listing_password_catalog_name POST /v1/marketplace/catalog/{public_name}/verify Verify Password for Marketplace Listing

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

info@mixpeek.com