Update Source

PATCH

/v1/sources/:source_id

Update the name or documentation of an existing data source.

Path parameters

source_idstringRequired

Request

This endpoint expects an object.

namestringOptional

The name of the source.

descriptionstringOptional

The description of the source.

metadata_map from strings to anyOptional

Metadata associated with the source.

embedding_configobjectOptional

The embedding configuration used by the source.

Response

Successful Response

namestring

The name of the source.

embedding_configobject

The embedding configuration used by the source.

idstringOptionalformat: "^source-[a-fA-F0-9]{8}"

The human-friendly ID of the Source

descriptionstringOptional

The description of the source.

organization_idstringOptional

The ID of the organization that created the source.

metadata_map from strings to anyOptional

Metadata associated with the source.

created_by_idstringOptional

The id of the user that made this Tool.

last_updated_by_idstringOptional

The id of the user that made this Tool.

created_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp when the source was created.

updated_atdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The timestamp when the source was last updated.

Errors

PATCH

1 curl -X PATCH https://app.letta.com/v1/sources/source_id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "name": "name",
3   "embedding_config": {
4     "embedding_endpoint_type": "openai",
5     "embedding_model": "embedding_model",
6     "embedding_dim": 1,
7     "embedding_endpoint": "embedding_endpoint",
8     "embedding_chunk_size": 1,
9     "handle": "handle",
10     "azure_endpoint": "azure_endpoint",
11     "azure_version": "azure_version",
12     "azure_deployment": "azure_deployment"
13   },
14   "id": "source-123e4567-e89b-12d3-a456-426614174000",
15   "description": "description",
16   "organization_id": "organization_id",
17   "metadata_": {
18     "key": "value"
19   },
20   "created_by_id": "created_by_id",
21   "last_updated_by_id": "last_updated_by_id",
22   "created_at": "2024-01-15T09:30:00Z",
23   "updated_at": "2024-01-15T09:30:00Z"
24 }

Get Source Id By Name

Up Next

Built with

1	curl -X PATCH https://app.letta.com/v1/sources/source_id \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"name": "name",
3	"embedding_config": {
4	"embedding_endpoint_type": "openai",
5	"embedding_model": "embedding_model",
6	"embedding_dim": 1,
7	"embedding_endpoint": "embedding_endpoint",
8	"embedding_chunk_size": 1,
9	"handle": "handle",
10	"azure_endpoint": "azure_endpoint",
11	"azure_version": "azure_version",
12	"azure_deployment": "azure_deployment"
13	},
14	"id": "source-123e4567-e89b-12d3-a456-426614174000",
15	"description": "description",
16	"organization_id": "organization_id",
17	"metadata_": {
18	"key": "value"
19	},
20	"created_by_id": "created_by_id",
21	"last_updated_by_id": "last_updated_by_id",
22	"created_at": "2024-01-15T09:30:00Z",
23	"updated_at": "2024-01-15T09:30:00Z"
24	}