For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DASHBOARDPLAYGROUNDDOCSCOMMUNITYLOG IN
Guides and conceptsAPI ReferenceRelease NotesLLMUCookbooks
Guides and conceptsAPI ReferenceRelease NotesLLMUCookbooks
  • Cohere API
    • About
    • Teams and Roles
    • Errors
    • Migrating From API v1 to API v2
    • Using the OpenAI SDK
  • Endpoints
  • Deprecated
      • GETList Connectors
      • POSTCreate a Connector
      • GETGet a Connector
      • PATCHUpdate a Connector
      • DELDelete a Connector
      • POSTAuthorize with oAuth
LogoLogodocs
DASHBOARDPLAYGROUNDDOCSCOMMUNITYLOG IN
Deprecatedv1/connectors

Create a Connector

Deprecated
POST
https://api.cohere.com/v1/connectors
POST
/v1/connectors
1import cohere
2
3co = cohere.Client()
4response = co.connectors.create(
5    name="Example connector",
6    url="https://connector-example.com/search",
7)
8print(response)
1{
2  "connector": {
3    "id": "salesforce-crm-connector-01",
4    "name": "Salesforce CRM Connector",
5    "created_at": "2024-01-15T09:30:00Z",
6    "updated_at": "2024-01-15T09:30:00Z",
7    "organization_id": "org-7890",
8    "description": "Connector to integrate Salesforce CRM data for document search and retrieval.",
9    "url": "https://api.salesforce.com/v1/search",
10    "excludes": [
11      "password",
12      "ssn"
13    ],
14    "auth_type": "service_auth",
15    "oauth": {
16      "client_id": "sf-client-12345",
17      "client_secret": "encrypted-secret-67890",
18      "authorize_url": "https://login.salesforce.com/services/oauth2/authorize",
19      "token_url": "https://login.salesforce.com/services/oauth2/token",
20      "scope": "api refresh_token"
21    },
22    "auth_status": "valid",
23    "active": true,
24    "continue_on_failure": true
25  }
26}
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'](https://docs.cohere.com/v1/docs/creating-and-deploying-a-connector) for more information.
Was this page helpful?
Previous

Get a Connector

Next
Built with

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.

Authentication

AuthorizationBearer

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

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.

activebooleanOptionalDefaults to true
Whether the connector is active or not.
continue_on_failurebooleanOptionalDefaults to false
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

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
498
Invalid Token Error
499
Client Closed Request Error
500
Internal Server Error
501
Not Implemented Error
503
Service Unavailable Error
504
Gateway Timeout Error