Update Custom Data Source

Update metadata and optionally extend the schema (append-only columns).

PUT /api/v1/custom-data-sources/{id_or_slug}

Update Custom Data Source

cURL

curl --request PUT \
  --url https://{tenant_id}.api.useago.com/api/v1/custom-data-sources/{id_or_slug} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "extraction_prompt": "<string>",
  "is_active": true,
  "added_columns": [
    {
      "name": "<string>",
      "nullable": true,
      "indexed": false
    }
  ],
  "searchable_fields_to_add": [
    "<string>"
  ],
  "label_field": "<string>"
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/custom-data-sources/{id_or_slug}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "extraction_prompt": "<string>",
    "is_active": True,
    "added_columns": [
        {
            "name": "<string>",
            "nullable": True,
            "indexed": False
        }
    ],
    "searchable_fields_to_add": ["<string>"],
    "label_field": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    extraction_prompt: '<string>',
    is_active: true,
    added_columns: [{name: '<string>', nullable: true, indexed: false}],
    searchable_fields_to_add: ['<string>'],
    label_field: '<string>'
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/custom-data-sources/{id_or_slug}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "extraction_prompt": "<string>",
  "is_active": true,
  "schema_definition": {
    "columns": [
      {
        "name": "<string>",
        "nullable": true,
        "indexed": false
      }
    ],
    "searchable_fields": [
      "<string>"
    ],
    "label_field": "<string>"
  },
  "embedding_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

id_or_slug · string · required

Body

application/json

Metadata update + append-only schema extension (add new nullable columns).

name · string | null

description · string | null

extraction_prompt · string | null

is_active · boolean | null

added_columns · ColumnDefinition · object[] | null

Show child attributes

searchable_fields_to_add · string[] | null

label_field · string | null

Response

200 - application/json

OK

id · string<uuid> · required

name · string · required

slug · string · required

description · string · required

extraction_prompt · string · required

is_active · boolean · required

schema_definition · CustomDataSourceSchema · object · required

Schema of a custom datasource: its columns, search config, and display field.

Show child attributes

embedding_model_id · string<uuid> | null · required

created_at · string<date-time> · required

updated_at · string<date-time> · required