Get Custom Data Source

Get full detail, including the schema definition.

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

Get Custom Data Source

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/custom-data-sources/{id_or_slug} \
  --header 'X-API-Key: <api-key>'

import requests

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

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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

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