Pipeline Data Sources

Add Data Sources To Pipeline

Changed on

Add data sources to a pipeline.

put/api/v1/pipelines/{pipeline_id}/data-sources

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/pipelines/{pipeline_id}/data-sources
  • Auth: HTTP bearer

Path parameters

pipeline_idstring uuid required

Query parameters

project_idstring uuid nullable

Cookies

sessionstring nullable

Request body

data_source_idstring uuid required

The ID of the data source.

sync_intervalnumber nullable

The interval at which the data source should be synced. Valid values are: 21600, 43200, 86400

Response

Successful Response

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring required

The name of the data source.

source_type'S3' | 'AZURE_STORAGE_BLOB' | 'GOOGLE_DRIVE' | 'MICROSOFT_ONEDRIVE' | 'MICROSOFT_SHAREPOINT' | 'SLACK' | 'NOTION_PAGE' | 'CONFLUENCE' | 'JIRA' | 'JIRA_V2' | 'BOX' required
custom_metadataobject nullable

Custom metadata that will be present on all data loaded from the data source

project_idstring uuid required
data_source_idstring uuid required

The ID of the data source.

pipeline_idstring uuid required

The ID of the pipeline.

last_synced_atstring date-time required

The last time the data source was automatically synced.

sync_intervalnumber nullable

The interval at which the data source should be synced.

sync_schedule_set_bystring nullable

The id of the user who set the sync schedule.

status'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'CANCELLED' nullable

The status of the data source in the pipeline.

status_updated_atstring date-time nullable

The last time the status was updated.

Changes

  • a38b684f8e1bRevision changes
    • info

      endpoint deprecated

    • info

      added the new optional query request parameter project_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      response property items/component/anyOf[subschema #6: CloudSharepointDataSource]/get_permissions list-of-types was narrowed by removing types null from media type application/json of response 200

  • 614771991b52Revision changes
    • breaking

      response property items/component/anyOf[subschema #6: CloudSharepointDataSource]/get_permissions list-of-types was widened by adding types null to media type application/json of response 200

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status