Create a Connector

Creates a new connector. The connector is tested during registration and will cancel registration when the test is unsuccessful. See ‘Creating and Deploying a Connector’ for more information.

Headers

X-Client-NamestringOptional

The name of the project that is making the request.

Request

This endpoint expects an object.

namestringRequired

A human-readable name for the connector.

urlstringRequired

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

descriptionstringOptional

A description of the connector.

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

Whether the connector is active or not.

continue_on_failurebooleanOptional

Whether a chat request should continue or not if the request to this connector fails.

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.

1	import cohere
2
3	co = cohere.Client("<<apiKey>>")
4	response = co.connectors.create(
5	name="Example connector",
6	url="https://connector-example.com/search",
7	)
8	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	}