POST /v1/connectors
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.
Servers
- https://api.cohere.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Client-Name |
String | No |
The name of the project that is making the request. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
A human-readable name for the connector. |
description |
String | No |
A description of the connector. |
excludes[] |
Array | No |
A list of fields to exclude from the prompt (fields remain in the document). |
active |
Boolean | No |
Whether the connector is active or not. Default value: true |
url |
String | Yes |
The URL of the connector that will be used to search for documents. |
oauth |
Object | No |
The OAuth 2.0 configuration for the connector. Cannot be specified if service_auth is specified. |
oauth.client_id |
String | No |
The OAuth 2.0 client ID. This fields is encrypted at rest. |
oauth.client_secret |
String | No |
The OAuth 2.0 client Secret. This field is encrypted at rest and never returned in a response. |
oauth.authorize_url |
String | No |
The OAuth 2.0 /authorize endpoint to use when users authorize the connector. |
oauth.token_url |
String | No |
The OAuth 2.0 /token endpoint to use when users authorize the connector. |
oauth.scope |
String | No |
The OAuth scopes to request when users authorize the connector. |
service_auth |
Object | No |
The service to service authentication configuration for the connector. Cannot be specified if oauth is specified. |
service_auth.token |
String | Yes |
The token that will be used in the HTTP Authorization header when making requests to the connector. This field is encrypted at rest and never returned in a response. |
service_auth.type |
String | Yes |
The token_type specifies the way the token is passed in the Authorization header. Valid values are "bearer", "basic", and "noscheme". Possible values:
Default value: "noscheme" |
continue_on_failure |
Boolean | No |
Whether a chat request should continue or not if the request to this connector fails. Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.