Skip to main content
POST
Create Source

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Query Parameters

organization_id
string | null

Organization ID for usage tracking

Body

application/json
type
enum<string>
required
Available options:
repository,
documentation,
research_paper,
huggingface_dataset,
local_folder,
slack,
google_drive,
connector
repository
string | null
branch
string | null
ref
string | null
url
string | null
url_patterns
string[] | null
exclude_patterns
string[] | null
project_id
string | null
max_age
integer | null
formats
string[] | null
only_main_content
boolean | null
limit
integer | null
max_depth
integer | null
crawl_entire_domain
boolean | null
wait_for
integer | null
include_screenshot
boolean | null
check_llms_txt
boolean | null
llms_txt_strategy
string | null
add_as_global_source
boolean | null
default:true
is_pdf
boolean | null
is_spreadsheet
boolean | null
display_name
string | null
gcs_path
string | null
focus_instructions
string | null
extract_branding
boolean | null
extract_images
boolean | null
config
string | null
folder_name
string | null
folder_path
string | null
files
FileItem · object[] | null
database
DatabaseFileItem · object | null

A database file for upload.

slack_installation_id
string | null
google_drive_installation_id
string | null
google_drive_file_ids
string[] | null
google_drive_folder_ids
string[] | null

Response

Successful Response

Unified source representation.

id
string
required

Source identifier

type
enum<string>
required

Source type

Available options:
repository,
documentation,
research_paper,
huggingface_dataset,
local_folder,
slack,
google_drive,
connector
identifier
string | null

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

display_name
string | null

Human-readable name

status
string | null

Indexing status

created_at
string | null

Creation timestamp (ISO)

updated_at
string | null

Last update timestamp (ISO)

category_id
string | null

Category assignment

is_global
boolean | null

Whether the source is global/shared

global_source_id
string | null

Global source ID if applicable

global_namespace
string | null

Global namespace if applicable

metadata
Metadata · object

Type-specific metadata

curation
SourceCurationSummary · object | null

Trust signals and curated guidance summary