GET
/
api
/
v1
/
data_sources
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dataSources.list({});

  // Handle the result
  console.log(result);
}

run();
{
  "items": [
    {
      "name": "Rain",
      "description": "Information about rain.",
      "labels": [
        "Weather Info"
      ],
      "chunk": false,
      "chunk_delimiter": "",
      "id": 1,
      "edit_comments": "Added new info",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_updated_by": "user@email.com"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "total_count": 123
}

Authorizations

Syllable-API-Key
string
header
required

Query Parameters

page
integer | null
default:0
Required range: x >= 0
limit
integer
default:25
Required range: x >= 0
search_fields
enum<string>[]
Available options:
name,
description,
labels,
chunk,
chunk_delimiter,
updated_at,
last_updated_by
search_field_values
string[]
order_by
enum<string> | null
Available options:
name,
description,
labels,
chunk,
chunk_delimiter,
updated_at,
last_updated_by
order_by_direction
enum<string> | null
Available options:
asc,
desc
fields
enum<string>[] | null
Available options:
name,
description,
labels,
chunk,
chunk_delimiter,
updated_at,
last_updated_by
start_datetime
string | null
end_datetime
string | null

Response

200
application/json
Successful Response
items
object[]
required

Metadata about a data source, not including the text.

page
integer
required
page_size
integer
required
total_pages
integer | null
total_count
integer | null