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.

post/v1/connectors

Request

  • Base URL: https://api.cohere.com
  • URL: https://api.cohere.com/v1/connectors
  • Auth: HTTP bearer

Headers

X-Client-Namestring

The name of the project that is making the request.

Request body

namestring required

A human-readable name for the connector.

descriptionstring

A description of the connector.

urlstring required

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

excludesstring[]

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

activeboolean

Whether the connector is active or not.

continue_on_failureboolean

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

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.