Sign in
connections
beta
enterprise

Create Connection

Create a connection. This is only for non-oauth connections such as S3 compatible connections, Freshdesk, and Zendesk.

post/connection

Request body

partitionstring nullable
page_limitinteger nullable
configobject nullable
metadataobject

Metadata for the document. Keys must be strings. Values may be strings, numbers, booleans, or lists of strings. Numbers may be integers or floating point and will be converted to 64 bit floating point. 1000 total values are allowed. Each item in an array counts towards the total. The following keys are reserved for internal use: document_id, document_type, document_source, document_name, document_uploaded_at, start_time, end_time, chunk_content_type.

workflow'parse' | 'index'
sync_filterSyncFilter

Response

Successful Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
metadataobject required
typestring required
namestring required
enabledboolean required
disabled_by_system_reason'connection_over_total_page_limit' | 'authentication_failed' | 'tenant_account_disabled' nullable required
last_synced_atstring date-time nullable
syncingboolean nullable
partitionstring nullable
page_limitinteger nullable required
sync_filterSyncFilter required
disabled_by_systemboolean required

Changes