API Reference
API Reference

List Data Sources

Fetch metadata about all data sources, not including their text.

GET/api/v1/data_sources/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

page integer | null query optional

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

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

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

Default []Example name
Item schema
itemsenum<string>required

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

Allowed values ["name","description","labels","chunk","chunk_delimiter","updated_at","last_updated_by"]
search_field_values string[] query optional

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

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["name","description","labels","chunk","chunk_delimiter","updated_at","last_updated_by"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required

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

Allowed values ["name","description","labels","chunk","chunk_delimiter","updated_at","last_updated_by"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_DataSourceMetadataResponse_ required
5 fields
itemsDataSourceMetadataResponse[]required

List of items returned from the query

Item schema
itemsDataSourceMetadataResponserequired

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.

9 fields
namestringrequired

The data source name. Must be unique within suborg. Cannot contain whitespace.

descriptionstring | nulloptional

The description of the data source.

labelsstring[]optional

Searchable labels for the data source. Can be included in agent.prompt_tool_defaults for a given tool to give the agent access to data sources with those labels when calling that tool.

Default []
Item schema
itemsstringrequired
chunkbooleanrequired

Whether the content should be split into smaller chunks. (This feature is coming in the future - currently this value will always be treated as False.)

chunk_delimiterstring | nulloptional

String that should be treated as delimiter between intended chunks. (This feature is coming in the future - currently this value will always be treated as None.)

idintegerrequired

The data source ID.

edit_commentsstring | nulloptional

The comments for the most recent edit to the data source

updated_atstring (date-time)required

Timestamp of most recent update

last_updated_bystring | nullrequired

Email of the user who last updated the data source

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

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

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "name": "string",
      "description": "string",
      "labels": [],
      "chunk": true,
      "chunk_delimiter": "string",
      "id": 0,
      "edit_comments": "string",
      "updated_at": "string",
      "last_updated_by": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}