API Reference
API Reference

Update Data Source

Update an existing data source.

PUT/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

This endpoint has no declared parameters.

Request body

application/json

body DataSourceUpdateRequest required
8 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

textstringrequired

Information that the data source will provide to the agent accessing it. It is recommended to include a sentence at the beginning providing context to the LLM for the information in the data source.

Request example
{
  "name": "string",
  "description": "string",
  "labels": [],
  "chunk": true,
  "chunk_delimiter": "string",
  "id": 0,
  "edit_comments": "string",
  "text": "string"
}

Responses

200Successful Response

application/json

response DataSourceDetailResponse required
10 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

textstringrequired

Information that the data source will provide to the agent accessing it.

Response example
{
  "name": "string",
  "description": "string",
  "labels": [],
  "chunk": true,
  "chunk_delimiter": "string",
  "id": 0,
  "edit_comments": "string",
  "updated_at": "string",
  "last_updated_by": "string",
  "text": "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"
    }
  ]
}