Update a Connector

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.

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.

activebooleanOptionalDefaults to true

continue_on_failurebooleanOptionalDefaults to false

service_authobjectOptional

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

Response

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.

1	import cohere
2
3	co = cohere.Client()
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": "foo",
4	"name": "foo",
5	"created_at": "foo",
6	"updated_at": "foo",
7	"organization_id": "foo",
8	"description": "foo",
9	"url": "foo",
10	"excludes": [
11	"foo"
12	],
13	"auth_type": "foo",
14	"oauth": {
15	"authorize_url": "foo",
16	"token_url": "foo",
17	"client_id": "foo",
18	"client_secret": "foo",
19	"scope": "foo"
20	},
21	"auth_status": "valid",
22	"active": true,
23	"continue_on_failure": true
24	}
25	}

Update a Connector

Path parameters

Headers

Request

Response

Errors