AmgixClient.Api.AmgixApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| CollectionExists | GET /v1/collections/{collection_name}/exists | Collection Exists |
| CreateCollection | POST /v1/collections/{collection_name} | Create Collection |
| DeleteCollection | DELETE /v1/collections/{collection_name} | Delete Collection |
| DeleteCollectionQueue | DELETE /v1/collections/{collection_name}/queue | Delete Collection Queue |
| DeleteDocument | DELETE /v1/collections/{collection_name}/documents/{document_id} | Delete Document |
| DeleteDocumentSync | DELETE /v1/collections/{collection_name}/documents/{document_id}/sync | Delete Document Sync |
| EmptyCollection | POST /v1/collections/{collection_name}/empty | Empty Collection |
| ExportDocuments | GET /v1/collections/{collection_name}/documents/export | Export Documents |
| FetchDocuments | POST /v1/collections/{collection_name}/documents/fetch | Fetch Documents |
| GetCollectionConfig | GET /v1/collections/{collection_name} | Get Collection Config |
| GetCollectionQueueInfo | GET /v1/collections/{collection_name}/queue/info | Get Collection Queue Info |
| GetCollectionStats | GET /v1/collections/{collection_name}/stats | Get Collection Stats |
| GetDocument | GET /v1/collections/{collection_name}/documents/{document_id} | Get Document |
| GetDocumentStatus | GET /v1/collections/{collection_name}/documents/{document_id}/status | Get Document Status |
| HealthCheck | GET /v1/health/check | Health |
| HealthReady | GET /v1/health/ready | Readiness Check |
| ListCollections | GET /v1/collections | List Collections |
| MetricsCurrent | GET /v1/metrics/current | Metrics Current |
| MetricsDefinitions | GET /v1/metrics/definitions | Metrics Definitions |
| MetricsPrometheus | GET /v1/metrics/prometheus | Metrics Prometheus |
| MetricsTrends | GET /v1/metrics/trends | Metrics Trends |
| Search | POST /v1/collections/{collection_name}/search | Search |
| SystemInfo | GET /v1/system/info | System Info |
| UpsertDocument | POST /v1/collections/{collection_name}/documents | Upsert Document |
| UpsertDocumentSync | POST /v1/collections/{collection_name}/documents/sync | Upsert Document Sync |
| UpsertDocumentsBulk | POST /v1/collections/{collection_name}/documents/bulk | Upsert Documents Bulk |
| Version | GET /v1/version | Version |
CollectionExists
CollectionExistsResponse CollectionExists (string collectionName)
Collection Exists
Check if a collection exists. Always returns 200 with exists true or false.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateCollection
OkResponse CreateCollection (string collectionName, CollectionConfig collectionConfig)
Create Collection
Create a new collection. This endpoint creates a new collection with the specified name and vector configurations. It validates the provided model configurations and ensures all required features are supported by the database. Args: collection_name: The unique name for the new collection (alphanumeric, underscores, hyphens only). config: Configuration details for the collection, including vector types and storage options. Returns: An OkResponse object indicating the success of the operation. Raises: HTTPException: - 400 if model validation fails or required features are not supported. - 409 if a collection with the same name already exists. - 500 if the collection creation fails in the database.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| collectionConfig | CollectionConfig |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCollection
OkResponse DeleteCollection (string collectionName)
Delete Collection
Delete a collection. Deletes a collection and all its associated data. This operation is irreversible. Args: collection_name: The name of the collection to delete. Returns: An OkResponse object indicating the success of the operation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCollectionQueue
OkResponse DeleteCollectionQueue (string collectionName)
Delete Collection Queue
Delete all queue entries for a collection. Removes all documents from the processing queue for a specified collection. This does not affect documents already indexed in the collection. Args: collection_name: The name of the collection for which to delete queue entries. Returns: An OkResponse object indicating the success of the operation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDocument
OkResponse DeleteDocument (string collectionName, string documentId, DateTime requestTimestamp)
Delete Document
Delete a document asynchronously. Queues a document for deletion and returns immediately. The document will be deleted asynchronously. Args: collection_name: The name of the collection. document_id: The unique identifier of the document to delete. Returns: An OkResponse object indicating the success of the operation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| documentId | string | ||
| requestTimestamp | DateTime | Caller-supplied delete timestamp (UTC) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDocumentSync
OkResponse DeleteDocumentSync (string collectionName, string documentId, DateTime requestTimestamp)
Delete Document Sync
Delete a document synchronously. Deletes a specific document by its ID from the specified collection and waits for the operation to complete. Args: collection_name: The name of the collection. document_id: The unique identifier of the document to delete. Returns: An OkResponse object indicating the success of the operation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| documentId | string | ||
| requestTimestamp | DateTime | Caller-supplied delete timestamp (UTC) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EmptyCollection
OkResponse EmptyCollection (string collectionName)
Empty Collection
Empty a collection. Removes all documents and their associated vector data from a specified collection, but keeps the collection's configuration. Args: collection_name: The name of the collection to empty. Returns: An OkResponse object indicating the success of the operation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExportDocuments
System.IO.Stream ExportDocuments (string collectionName, bool withVectors = null)
Export Documents
Export all documents in a collection as a downloadable gzip-compressed JSON array. Streams [{...},{...},...] without loading the full collection into memory.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| withVectors | bool | When true, include stored vector values on each exported document. | [optional] [default to false] |
Return type
System.IO.Stream
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/gzip, application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Gzip-compressed UTF-8 JSON file. After gunzip, the payload is a JSON array of Document objects (Document[]). Suggested filename is in Content-Disposition. | * Content-Disposition - attachment; filename=\"{collection_name}-{timestamp}.json.gz\" |
| 404 | Collection not found | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
FetchDocuments
DocumentFetchResponse FetchDocuments (string collectionName, DocumentFetchRequest documentFetchRequest)
Fetch Documents
Fetch a page of documents from a collection. Returns documents in stable internal order with cursor-based pagination. Pass the returned after token in the next request to get the following page. after is null when there are no more documents. Args: collection_name: The name of the collection. body: Pagination and filter parameters. Returns: A DocumentFetchResponse with a page of documents and a pagination token. Raises: HTTPException: 404 if the collection does not exist. HTTPException: 400 if a filter references an unindexed metadata key.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| documentFetchRequest | DocumentFetchRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCollectionConfig
CollectionConfig GetCollectionConfig (string collectionName)
Get Collection Config
Get collection configuration. Retrieves the configuration details for a specific collection. Args: collection_name: The name of the collection. Returns: The configuration of the specified collection.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCollectionQueueInfo
QueueInfo GetCollectionQueueInfo (string collectionName)
Get Collection Queue Info
Get queue statistics for a collection. Retrieves counts of documents in different queue states (queued, requeued, failed). Args: collection_name: The name of the collection. Returns: A QueueInfo object with counts for each queue state.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCollectionStats
CollectionStatsResponse GetCollectionStats (string collectionName)
Get Collection Stats
Get persisted collection statistics and queue counts. Returns document counts maintained by the indexing pipeline (not a live physical count), plus queue entry counts by state (same data as GET .../queue/info). Args: collection_name: The name of the collection. Returns: A CollectionStatsResponse with doc_count and queue. Raises: HTTPException: 404 if the collection does not exist.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetDocument
Document GetDocument (string collectionName, string documentId, bool withVectors = null)
Get Document
Retrieve a single document. Retrieves a specific document by its ID from the specified collection. Args: collection_name: The name of the collection. document_id: The unique identifier of the document to retrieve. with_vectors: When true, include stored vector values on the document. Returns: The retrieved Document object. Raises: HTTPException: 404 if the document is not found in the collection.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| documentId | string | ||
| withVectors | bool | When true, include stored vector values on the document. | [optional] [default to false] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetDocumentStatus
DocumentStatusResponse GetDocumentStatus (string collectionName, string documentId)
Get Document Status
Get document processing status. Retrieves the processing status of a document, including its current state in the queue and any associated messages. Args: collection_name: The name of the collection. document_id: The unique identifier of the document. Returns: A DocumentStatusResponse object containing the processing status of the document. Raises: HTTPException: 404 if the document is not found in the collection's queue.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| documentId | string |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
HealthCheck
OkResponse HealthCheck ()
Health
Check API service responsiveness. This endpoint returns a simple 'ok' status to indicate that the API service is running and able to respond to requests. Returns: An OkResponse object with the 'ok' field set to True, confirming the service's responsiveness.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
HealthReady
ReadyResponse HealthReady ()
Readiness Check
Check if service is ready to handle requests. Runs four probes: database, rabbitmq, index workers, query workers. Returns 200 if all pass (fully ready), 218 if some fail (partial ready). Response body always includes all four probe results and a ready flag.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Fully ready | - |
| 218 | Partial ready (some index/query probes not ready) | - |
| 503 | Service Unavailable (infra down or all encoder roles down) | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListCollections
List<string> ListCollections ()
List Collections
List all available collections. Retrieves a list of all collections managed by the application. Returns: A list of strings, where each string is the name of an available collection.
Parameters
This endpoint does not need any parameter.
Return type
List
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MetricsCurrent
Metrics MetricsCurrent (int window = null, List
keys = null)
Metrics Current
Return the current metrics state for all nodes over the given window (seconds).
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| window | int | Aggregation window in seconds - 30 or 60. | [optional] [default to 60] |
| keys | List<string> | Restrict returned metric series to these keys. Omit for all keys. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MetricsDefinitions
List<MetricDefinitionItem> MetricsDefinitions ()
Metrics Definitions
Return catalog entries for all known metric keys, their units, and descriptions.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MetricsPrometheus
string MetricsPrometheus ()
Metrics Prometheus
Expose current cluster metrics in Prometheus text exposition (60s rolling window).
Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: text/plain
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
MetricsTrends
List<MetricTrend> MetricsTrends (DateTime since, DateTime until, int resolution = null, List
keys = null)
Metrics Trends
Return historical metric buckets for the given time range and resolution. Args: since: Inclusive start of the time range (ISO 8601, UTC assumed if no timezone given). until: Exclusive end of the time range (ISO 8601, UTC assumed if no timezone given). resolution: Bucket size in seconds - 60 for 1-minute, 300 for 5-minute. keys: One or more metric keys to return. Omit to return all keys.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| since | DateTime | ||
| until | DateTime | ||
| resolution | int | Bucket size in seconds - 60 for 1-minute, 300 for 5-minute. | [optional] [default to 60] |
| keys | List<string> | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Search
SearchResponse Search (string collectionName, SearchQuery searchQuery)
Search
Perform a search query on a collection. Executes a search query against the specified collection. Args: collection_name: The name of the collection to search. query: The SearchQuery object containing the search text, filters, and other parameters. Returns: A SearchResponse with search hits and server-side query timing.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| searchQuery | SearchQuery |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SystemInfo
SystemInfoResponse SystemInfo ()
System Info
Summarize deployment and infrastructure (no connection URLs).
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpsertDocument
OkResponse UpsertDocument (string collectionName, Document document)
Upsert Document
Upsert a single document asynchronously. Adds or updates a single document in the specified collection by placing it into a processing queue. The document will be vectorized and indexed asynchronously. Args: collection_name: The name of the collection to upsert the document into. document: The document object to be upserted. Returns: An OkResponse object indicating that the document has been accepted for processing. Raises: HTTPException: 500 if publishing the event to the internal queue fails.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| document | Document |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpsertDocumentSync
OkResponse UpsertDocumentSync (string collectionName, Document document)
Upsert Document Sync
Upsert a single document synchronously. Adds or updates a single document in the specified collection and waits for the operation to complete, including vectorization and indexing. Args: collection_name: The name of the collection to upsert the document into. document: The document object to be upserted. Returns: An OkResponse object indicating the success of the operation. Raises: HTTPException: - 409 if a document with the same ID and newer timestamp already exists (conflict). - 500 for other internal server errors during processing.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| document | Document |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpsertDocumentsBulk
OkResponse UpsertDocumentsBulk (string collectionName, BulkUploadRequest bulkUploadRequest)
Upsert Documents Bulk
Upsert multiple documents in bulk asynchronously. Adds or updates multiple documents in the specified collection by placing them into a processing queue. Documents will be vectorized and indexed asynchronously. This method is optimized for bulk operations. Args: collection_name: The name of the collection to upsert the documents into. request: A BulkUploadRequest object containing a list of Document objects to be upserted. Returns: An OkResponse object indicating that the documents have been accepted for processing. Raises: HTTPException: 500 if publishing events to the internal queue fails for any document.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | string | Collection name (alphanumeric, underscores, hyphens only) | |
| bulkUploadRequest | BulkUploadRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
| 422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Version
VersionResponse Version ()
Version
Return the system version. Returns: A VersionResponse object with the system version.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful Response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]