Link Search Menu Expand Document Documentation Menu

Create Connector API

Creates a standalone connector. For more information, see Connectors.

Endpoints

POST /_plugins/_ml/connectors/_create 

Request body fields

For a list of request fields, see Blueprint configuration parameters.

Example request

To create a standalone connector, send a request to the connectors/_create endpoint and provide all of the parameters described in Connector blueprints:

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} }" } ] } 

Example response

{ "connector_id": "a1eMb4kBJ1eYAeTMAljY" } 
350 characters left

Have a question? .

Want to contribute? or .