Skip to navigation
API ReferenceConnectors

Create a Custom API connector

Authentication

AuthorizationBearer

Use a tq_live_ API key as a Bearer token.

Path parameters

index_idstringRequired

Headers

x-talqora-organization-idstring or nullOptional

Request

This endpoint expects an object.
namestringRequired1-120 characters
endpoint_urlstringRequired8-2048 characters
headersmap from strings to stringsOptional
authobjectOptional
content_pathstring or nullOptional<=512 characters
sync_interval_minutesintegerOptional15-1440Defaults to 60
requests_per_minuteintegerOptional1-120Defaults to 30

Response

Successful Response
idstring
connector_slugstring
namestring
endpoint_hoststring
sync_interval_minutesinteger
requests_per_minuteinteger
statusstring
content_pathstring or nullOptional

Errors

422
Unprocessable Entity Error