Update a Connector

PATCH

Update a connector by ID. Omitted fields will not be updated. See ‘Managing your Connector’ for more information.

Path parameters

idstringRequired

The ID of the connector to update.

Headers

X-Client-NamestringOptional

The name of the project that is making the request.

Request

This endpoint expects an object.

namestringOptional

A human-readable name for the connector.

urlstringOptional

The URL of the connector that will be used to search for documents.

excludeslist of stringsOptional

A list of fields to exclude from the prompt (fields remain in the document).

oauthobjectOptional

The OAuth 2.0 configuration for the connector. Cannot be specified if service_auth is specified.

activebooleanOptional

continue_on_failurebooleanOptional

service_authobjectOptional

The service to service authentication configuration for the connector. Cannot be specified if oauth is specified.

Response

This endpoint returns an object.

connectorobject

A connector allows you to integrate data sources with the ‘/chat’ endpoint to create grounded generations with citations to the data source. documents to help answer users.

PATCH

1 import cohere
2 
3 co = cohere.Client("<<apiKey>>")
4 response = co.connectors.update(
5     connector_id="test-id", name="new name", url="https://example.com/search"
6 )
7 print(response)

200Updated

1 {
2   "connector": {
3     "id": "id",
4     "name": "name",
5     "created_at": "2024-01-15T09:30:00Z",
6     "updated_at": "2024-01-15T09:30:00Z",
7     "organization_id": "organization_id",
8     "description": "description",
9     "url": "url",
10     "excludes": [
11       "excludes"
12     ],
13     "auth_type": "auth_type",
14     "oauth": {
15       "authorize_url": "authorize_url",
16       "token_url": "token_url",
17       "client_id": "client_id",
18       "client_secret": "client_secret",
19       "scope": "scope"
20     },
21     "auth_status": "valid",
22     "active": true,
23     "continue_on_failure": true
24   }
25 }

Delete a Connector

Up Next

Built with

1	import cohere
2
3	co = cohere.Client("<<apiKey>>")
4	response = co.connectors.update(
5	connector_id="test-id", name="new name", url="https://example.com/search"
6	)
7	print(response)

1	{
2	"connector": {
3	"id": "id",
4	"name": "name",
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"organization_id": "organization_id",
8	"description": "description",
9	"url": "url",
10	"excludes": [
11	"excludes"
12	],
13	"auth_type": "auth_type",
14	"oauth": {
15	"authorize_url": "authorize_url",
16	"token_url": "token_url",
17	"client_id": "client_id",
18	"client_secret": "client_secret",
19	"scope": "scope"
20	},
21	"auth_status": "valid",
22	"active": true,
23	"continue_on_failure": true
24	}
25	}