Update graph

Update an existing graphs's configuration. This endpoint allows updating the name and description of an existing collection. The user must have appropriate permissions to modify the collection.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_idstringRequired

The collection ID corresponding to the graph to update

Request

This endpoint expects an object.

namestringOptional

The name of the graph

descriptionstringOptional

An optional description of the graph

Response

Successful Response

resultsobject

1	from r2r import R2RClient
2
3	client = R2RClient()
4	# when using auth, do client.login(...)
5
6	response = client.graphs.update(
7	collection_id="d09dedb1-b2ab-48a5-b950-6e1f464d83e7",
8	graph={
9	"name": "New Name",
10	"description": "New Description"
11	}
12	)

1	{
2	"results": {
3	"id": "id",
4	"collection_id": "collection_id",
5	"name": "name",
6	"status": "status",
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"document_ids": [
10	"document_ids"
11	],
12	"description": "description"
13	}
14	}

Authentication

Path parameters

Headers

Request

Response

Errors