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

Get a Connector

Deprecated
GET
https://api.cohere.com/v1/connectors/:id
GET
/v1/connectors/:id
1import cohere
2
3co = cohere.Client()
4response = co.connectors.get("test-id")
5print(response)
1{
2  "connector": {
3    "id": "salesforce-crm-connector",
4    "name": "Salesforce CRM Integration",
5    "created_at": "2024-01-15T09:30:00Z",
6    "updated_at": "2024-04-10T14:45:00Z",
7    "organization_id": "org_9f8e7d6c5b4a3",
8    "description": "Connector to integrate Salesforce CRM data for customer insights and support.",
9    "url": "https://login.salesforce.com",
10    "excludes": [
11      "password",
12      "social_security_number"
13    ],
14    "auth_type": "oauth",
15    "oauth": {
16      "client_id": "3MVG9d9xX0Pz7a1q2b3c4d5e6f7g8h9i0jklmnopqrstu",
17      "client_secret": "encrypted_client_secret_value",
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}
Retrieve a connector by ID. See ['Connectors'](https://docs.cohere.com/docs/connectors) for more information.
Was this page helpful?
Previous

Update a Connector

Next
Built with

Retrieve a connector by ID. See ‘Connectors’ for more information.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired
The ID of the connector to retrieve.

Headers

X-Client-NamestringOptional
The name of the project that is making the request.

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