For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETGet collection details
      • PUTCreate a collection
      • DELDelete a collection
      • PATCHUpdate collection parameters
      • GETList all collections
      • GETCheck collection existence
      • PUTCreate named vector
      • DELDelete named vector
      • GETGet optimization progress
LogoLogo
CloudGitHub
API ReferenceCollections

Get optimization progress

GET
/collections/:collection_name/optimizations
GET
/collections/:collection_name/optimizations
$curl http://localhost:6333/collections/collection_name/optimizations \
>     -H "api-key: <apiKey>"
200Retrieved
1{
2  "usage": {
3    "hardware": {
4      "cpu": 1,
5      "payload_io_read": 1,
6      "payload_io_write": 1,
7      "payload_index_io_read": 1,
8      "payload_index_io_write": 1,
9      "vector_io_read": 1,
10      "vector_io_write": 1
11    },
12    "inference": {
13      "models": {}
14    }
15  },
16  "time": 0.002,
17  "status": "ok",
18  "result": {
19    "summary": {
20      "queued_optimizations": 1,
21      "queued_segments": 1,
22      "queued_points": 1,
23      "idle_segments": 1
24    },
25    "running": [
26      {
27        "uuid": "string",
28        "optimizer": "string",
29        "status": "optimizing",
30        "segments": [
31          {
32            "uuid": "string",
33            "points_count": 1
34          }
35        ],
36        "progress": {
37          "name": "string",
38          "started_at": "2024-01-15T09:30:00Z",
39          "finished_at": "2024-01-15T09:30:00Z",
40          "duration_sec": 1.1,
41          "done": 1,
42          "total": 1,
43          "children": [
44            null
45          ]
46        }
47      }
48    ],
49    "queued": [
50      {
51        "optimizer": "string",
52        "segments": [
53          {
54            "uuid": "string",
55            "points_count": 1
56          }
57        ]
58      }
59    ],
60    "completed": [
61      {
62        "uuid": "string",
63        "optimizer": "string",
64        "status": "optimizing",
65        "segments": [
66          {
67            "uuid": "string",
68            "points_count": 1
69          }
70        ],
71        "progress": {
72          "name": "string",
73          "started_at": "2024-01-15T09:30:00Z",
74          "finished_at": "2024-01-15T09:30:00Z",
75          "duration_sec": 1.1,
76          "done": 1,
77          "total": 1,
78          "children": [
79            null
80          ]
81        }
82      }
83    ],
84    "idle_segments": [
85      {
86        "uuid": "string",
87        "points_count": 1
88      }
89    ]
90  }
91}
Get progress of ongoing and completed optimizations for a collection
Was this page helpful?
Previous

Retrieve points

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection

Query parameters

withstringOptional

Comma-separated list of optional fields to include in the response. Possible values: queued, completed, idle_segments.

completed_limitintegerOptional>=0Defaults to 16

Maximum number of completed optimizations to return. Ignored if completed is not in the with parameter.

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultobject
Optimizations progress for the collection