Create connector

Authentication and request headers

Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.

Name	Location	Type	Required	Description	Example
Authorization	header	string	Yes	Application API key, passed as a Bearer token.	Bearer qwk_***
X-Request-Id	header	string	No	Optional request tracing identifier; generated by the server if omitted.	req-20260831-001

Name	Location	Type	Required	Description	Example
Idempotency-Key	header	string	Required	Idempotency key used to prevent duplicate submissions	"<string>"
api_key	body	OpenapifacadeConnectorAPIKeyConfig	No	API Key configuration	{"header_name":"<string>","value_prefix":"<string>"}
auth_type	body	string	Required	Authorization method	"none"
category_id	body	string · uuid	No	Category (category ID)	"<uuid>"
clients	body	array ｜ null	No	Supported clients	["<string>"]
command	body	string	No	Startup command	"<string>"
description	body	string	No	Description (English)	"<string>"
description_cn	body	string	No	Description	"<string>"
display_name	body	string	No	Connector name (English)	"<string>"
display_name_cn	body	string	No	Connector name	"<string>"
icon_upload_id	body	string · uuid	No	Resource icon (upload session ID)	"<uuid>"
icon_url	body	string · uri	No	Resource icon (URL)	"<string>"
oauth_client_registration	body	string	No	OAuth client registration configuration	"dcr"
oauth_scopes	body	string	No	OAuth Scopes	"<string>"
server_key	body	string	Required	Unique identifier	"<string>"
transport	body	string	Required	Transport protocol	"http"
url	body	string	No	Service URL	"<string>"

cURL

201 Created

Name	Type	Required	Description	Example
api_key	OpenapifacadeConnectorAPIKeyConfig	No	API Key configuration	{"header_name":"<string>","value_prefix":"<string>"}
api_key.header_name	string	Yes	Header name	"<string>"
api_key.value_prefix	string	No	Value prefix	"<string>"
auth_type	string	Yes	Authorization method	"<string>"
clients	array ｜ null	Yes	Supported clients	["<string>"]
command	string	No	Startup command	"<string>"
created_at	string · date-time	Yes	Created at	"2026-08-27T10:00:00Z"
description	string	No	Description (English)	"<string>"
description_cn	string	No	Description	"<string>"
display_name	string	No	Connector name (English)	"<string>"
display_name_cn	string	No	Connector name	"<string>"
icon_url	string	No	Resource icon (URL)	"<string>"
id	string	Yes	Connector ID	"<string>"
oauth_client_registration	string	No	OAuth client registration configuration	"<string>"
oauth_scopes	string	No	OAuth Scopes	"<string>"
origin	string	Yes	Origin	"<string>"
revision	integer · int64	Yes	Revision used for concurrent update checks	0
server_key	string	Yes	Unique identifier	"<string>"
source_type	string	No	Source type	"official"
status	string	Yes	Enabled	"<string>"
transport	string	Yes	Transport protocol	"<string>"
updated_at	string · date-time	Yes	Updated at	"2026-08-27T10:00:00Z"
url	string	No	Service URL	"<string>"
version	string	No	Version	"<string>"

Response example

default Flat business error

Name	Type	Required	Description	Example
code	string	No	Stable business error code	"<string>"
detail	string	Yes	Human-readable error description	"<string>"
details	OpenapiErrorDetails	No	Error details	{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.field	string	No	Request field that failed validation	"<string>"
details.reason	string	No	Stable validation failure reason	"<string>"
details.suggestion	string	No	Suggested normalized value	"<string>"
error	string	Yes	Stable HTTP error type	"<string>"

Response example