Sign in
Sources

Create Source

post/sources

Request body

type'repository' | 'documentation' | 'research_paper' | 'huggingface_dataset' | 'local_folder' | 'slack' | 'google_drive' required
repositorystring nullable
branchstring nullable
refstring nullable
urlstring nullable
url_patternsstring[] nullable
exclude_patternsstring[] nullable
project_idstring nullable
max_ageinteger nullable
formatsstring[] nullable
only_main_contentboolean nullable
limitinteger nullable
max_depthinteger nullable
crawl_entire_domainboolean nullable
wait_forinteger nullable
include_screenshotboolean nullable
check_llms_txtboolean nullable
llms_txt_strategystring nullable
add_as_global_sourceboolean nullable
is_pdfboolean nullable
is_spreadsheetboolean nullable
display_namestring nullable
gcs_pathstring nullable
focus_instructionsstring nullable
extract_brandingboolean nullable
extract_imagesboolean nullable
configstring nullable
folder_namestring nullable
folder_pathstring nullable
slack_installation_idstring nullable
google_drive_installation_idstring nullable
google_drive_file_idsstring[] nullable
google_drive_folder_idsstring[] nullable

Response

Successful Response

idstring required

Source identifier

type'repository' | 'documentation' | 'research_paper' | 'huggingface_dataset' | 'local_folder' | 'slack' | 'google_drive' required

Source type

identifierstring nullable

Canonical identifier (repo slug, URL, or folder path)

display_namestring nullable

Human-readable name

statusstring nullable

Indexing status

created_atstring nullable

Creation timestamp (ISO)

updated_atstring nullable

Last update timestamp (ISO)

category_idstring nullable

Category assignment

is_globalboolean nullable

Whether the source is global/shared

global_source_idstring nullable

Global source ID if applicable

global_namespacestring nullable

Global namespace if applicable

metadataobject

Type-specific metadata

Changes

Changed in 5 of the 9 revisions of this API.212

  • 264ed942dacc1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 2277d31213d115See the full diff
    • ●

      added the new google_drive enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new google_drive enum value to the request property

      request-property-enum-value-added

  • 056a9334ce0b12See the full diff
    • ●

      added the new slack enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new slack enum value to the request property

      request-property-enum-value-added

  • c41dcb6ac8f71See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5b3db391b9ea3See the full diff
    • ○

      api tag Sources added

      api-tag-added

    • ○

      api tag v2-api removed

      api-tag-removed

    • ○

      api tag v2-api-sources removed

      api-tag-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog