Skip to main content
PUT
/
v1
/
indexes
/
{indexId}
curl --location --request PUT 'https://api.getmetal.io/v1/indexes/test-index-id' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
    "status": "DEACTIVATING"
}'

{
  "data": {
    "id": "1",
    "createdAt": "2023-08-23T22:13:31.539Z",
    "status": "DEACTIVATING",
    "name": "Ozzy Osbourne",
    "model": "text-embedding-ada-002",
    "dimensions": 1536,
    "filters": [
      {
        "field": "name",
        "type": "string"
      },
      {
        "field": "age",
        "type": "number"
      }
    ],
    "chunkConfig": {
      "size": 500,
      "overlap": 20
    },
    "tableChunkConfig": {
      "size": 4000
    },
    "counts": {
      "docs": 0,
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getmetal.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Auth Headers

​
x-metal-api-key
string
required
An API key for your org.
​
x-metal-client-id
string
required
A Client ID for your org.

​
Params

​
indexId
string
required
The Index ID to update

​
Body

​
status
string
required
Status to update the index. Can only be DEACTIVATING to start the archiving process
​
chunkConfig
object
​
tableChunkConfig
object

​
Response

​
data
Index Object
curl --location --request PUT 'https://api.getmetal.io/v1/indexes/test-index-id' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
    "status": "DEACTIVATING"
}'

{
  "data": {
    "id": "1",
    "createdAt": "2023-08-23T22:13:31.539Z",
    "status": "DEACTIVATING",
    "name": "Ozzy Osbourne",
    "model": "text-embedding-ada-002",
    "dimensions": 1536,
    "filters": [
      {
        "field": "name",
        "type": "string"
      },
      {
        "field": "age",
        "type": "number"
      }
    ],
    "chunkConfig": {
      "size": 500,
      "overlap": 20
    },
    "tableChunkConfig": {
      "size": 4000
    },
    "counts": {
      "docs": 0,
    }
  }
}