GET
/
api
/
v1
/
data_sources
import os
import syllable_sdk
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.data_sources.list(page=0, search_fields=[
        syllable_sdk.DataSourceProperties.NAME,
    ], search_field_values=[
        "Some Object Name",
    ], start_datetime="2023-01-01T00:00:00Z", end_datetime="2024-01-01T00:00:00Z")

    # Handle response
    print(res)
{
  "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": 0,
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Authorizations

​
Syllable-API-Key
string
header
required

Query Parameters

​
page
integer | null
default:0

The page number from which to start (0-based)

Required range: x >= 0
Example:

0

​
limit
integer
default:25

The maximum number of items to return

Required range: x >= 0
Example:

25

​
search_fields
enum<string>[]

String names of fields to search. Correspond by index to search field values

Names of data source fields supported for filtering/sorting on list endpoint.

Available options:
name,
description,
labels,
chunk,
chunk_delimiter,
updated_at,
last_updated_by
Example:

"name"

​
search_field_values
string[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Example:

"Some Object Name"

​
order_by
enum<string> | null

The field whose value should be used to order the results

Available options:
name,
description,
labels,
chunk,
chunk_delimiter,
updated_at,
last_updated_by
Example:

"name"

​
order_by_direction
enum<string> | null

The direction in which to order the results

Available options:
asc,
desc
​
fields
enum<string>[] | null

The fields to include in the response

Names of data source fields supported for filtering/sorting on list endpoint.

Available options:
name,
description,
labels,
chunk,
chunk_delimiter,
updated_at,
last_updated_by
​
start_datetime
string | null

The start datetime for filtering results

Example:

"2023-01-01T00:00:00Z"

​
end_datetime
string | null

The end datetime for filtering results

Example:

"2024-01-01T00:00:00Z"

Response

200
application/json
Successful Response
​
items
object[]
required

List of items returned from the query

Metadata about a data source, not including the text. A data source is a blob of text that can be made available to an agent's general info tools to provide more context to the agent when generating its responses. For more information, see Console docs.

​
page
integer
required

The page number of the results (0-based)

Example:

0

​
page_size
integer
required

The number of items returned per page

Example:

25

​
total_pages
integer | null

The total number of pages of results given the indicated page size

Example:

4

​
total_count
integer | null

The total number of items returned from the query

Example:

100