Endpointsv1/connectors

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

AuthorizationstringRequired

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

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

OK
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.

Errors