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
      • PUTCreate payload index
      • DELDelete payload index
LogoLogo
CloudGitHub
API ReferenceIndexes

Create payload index

PUT
/collections/:collection_name/index
PUT
/collections/:collection_name/index
$curl -X PUT http://localhost:6333/collections/collection_name/index \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "field_name": "string"
>}'
200Updated
1{
2  "time": 1.1,
3  "status": "string",
4  "result": {
5    "status": "acknowledged",
6    "operation_id": 1
7  }
8}
Creates a payload index for a field in the specified collection.
Was this page helpful?
Previous

Delete payload index

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection

Query parameters

waitbooleanOptional
If true, wait for changes to actually happen
orderingenumOptional
define ordering guarantees for the operation
Allowed values:

Request

Field name
field_namestringRequired
field_schemaenum or object or anyOptional

Response

successful operation
timedouble
Time spent to process this request
statusstring
resultobject