2023-11-17 15:59:27 -05:00
---
layout: default
title: Create connector
parent: Connector APIs
grand_parent: ML Commons API
nav_order: 10
---
# Create a connector
2023-11-29 15:28:20 -05:00
Creates a standalone connector. For more information, see [Connectors ]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/ ).
2023-11-17 15:59:27 -05:00
## Path and HTTP methods
```json
POST /_plugins/_ml/connectors/_create
```
#### Example request
2023-11-29 15:28:20 -05:00
To create a standalone connector, send a request to the `connectors/_create` endpoint and provide all of the parameters described in [Connector blueprints ]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints/ ):
2023-11-17 15:59:27 -05:00
```json
POST /_plugins/_ml/connectors/_create
{
"name": "OpenAI Chat Connector",
"description": "The connector to public OpenAI model service for GPT 3.5",
"version": 1,
"protocol": "http",
"parameters": {
"endpoint": "api.openai.com",
"model": "gpt-3.5-turbo"
},
"credential": {
"openAI_key": "..."
},
"actions": [
{
"action_type": "predict",
"method": "POST",
"url": "https://${parameters.endpoint}/v1/chat/completions",
"headers": {
"Authorization": "Bearer ${credential.openAI_key}"
},
"request_body": "{ \"model\": \"${parameters.model}\", \"messages\": ${parameters.messages} }"
}
]
}
```
{% include copy-curl.html %}
#### Example response
```json
{
"connector_id": "a1eMb4kBJ1eYAeTMAljY"
}
```