Sign in

v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB
data_sources

Create Data Source

Create a new data source.

post/api/v1/data_sources/

Request body

namestring required

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

descriptionstring nullable

The description of the data source.

labelsstring[]

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.

chunkboolean required

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 nullable

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.)

textstring required

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.

Example request

{
  "name": "Rain",
  "description": "Information about rain.",
  "labels": [
    "Weather Info"
  ],
  "text": "The following are names and addresses of pizza shops.\n\nCool Pizza, 123 Main St.\n\nReally Good Pizza, 456 Water St.\n\nThe Best Pizza, 789 Circle Dr."
}

Response

Successful Response

namestring required

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

descriptionstring nullable

The description of the data source.

labelsstring[]

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.

chunkboolean required

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 nullable

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.)

idinteger required

The data source ID.

edit_commentsstring nullable

The comments for the most recent edit to the data source

updated_atstring date-time required

Timestamp of most recent update

last_updated_bystring nullable required

Email of the user who last updated the data source

textstring required

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

Example response

{
  "name": "Rain",
  "description": "Information about rain.",
  "labels": [
    "Weather Info"
  ],
  "id": 1,
  "edit_comments": "Added new info",
  "last_updated_by": "user@email.com"
}