API ReferenceSync

Create Sync

Create a new sync configuration.

Args:

db: The database session sync_in: The sync to create user: The current user background_tasks: The background tasks

Returns:

sync (schemas.Sync): The created sync

Headers

x-api-keystringOptional

Request

This endpoint expects an object.
namestringRequired
source_connection_idstringRequiredformat: "uuid"
destination_connection_idslist of stringsRequired
embedding_model_connection_idstringOptionalformat: "uuid"Defaults to 33333333-3333-3333-3333-333333333333
descriptionstringOptional
cron_schedulestringOptional
next_scheduled_rundatetimeOptional
white_label_idstringOptionalformat: "uuid"
white_label_user_identifierstringOptional
sync_metadatamap from strings to anyOptional
statusenumOptional

Sync status enum.

Allowed values:
run_immediatelybooleanOptionalDefaults to false

Response

Successful Response

namestring
source_connection_idstringformat: "uuid"
destination_connection_idslist of strings
statusenum

Sync status enum.

Allowed values:
idstringformat: "uuid"
organization_idstringformat: "uuid"
created_atdatetime
modified_atdatetime
created_by_emailstringformat: "email"
modified_by_emailstringformat: "email"
embedding_model_connection_idstringOptionalformat: "uuid"Defaults to 33333333-3333-3333-3333-333333333333
descriptionstringOptional
cron_schedulestringOptional
next_scheduled_rundatetimeOptional
white_label_idstringOptionalformat: "uuid"
white_label_user_identifierstringOptional
sync_metadatamap from strings to anyOptional

Errors