Skip to main content
PATCH
/
v1
/
beta
/
private_indexes
/
{id}
cURL
curl --request PATCH \
  --url https://trytako.com/api/v1/beta/private_indexes/{id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "is_default": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "ontology_status": "<string>",
  "description": "<string>",
  "kg_elements_bucket_key": "<string>",
  "data_mapping_bucket_keys": [
    "<string>"
  ]
}

​
Notes

  • To authenticate, you’ll need a Tako API key. It’s best practice to store it as an environment variable to avoid hardcoding sensitive credentials in your code.
  • Performs a partial update of an existing private index, allowing you to update only specific fields.
  • Unlike PUT, this endpoint only updates the fields you provide in the request body.
  • You can update the name, description, or both fields independently.
  • Returns the complete updated private index object with all metadata.
  • Returns a 404 error if the private index is not found or not accessible to the authenticated user.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

ID of the private index

Body

application/json
​
name
string

Name of the private index

​
description
string | null

Description of the private index

Response

Private index details

​
id
string
required
​
name
string
required
​
is_default
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
ontology_status
string
required
​
description
string | null
​
kg_elements_bucket_key
string | null
​
data_mapping_bucket_keys
string[] | null