Subscribe to a global source

Subscribe to an existing globally indexed public source. Creates a local reference for instant access without re-indexing.

post/sources/subscribe

Request

urlstring required

URL of the source (GitHub repo, docs URL, arXiv URL/ID, or HuggingFace dataset URL)

source_type'repository' | 'documentation' | 'research_paper' | 'huggingface_dataset' nullable

Source type. Auto-detected from URL if not provided.

refstring nullable

Git ref for repositories (branch, tag, or commit SHA)

Successful Response

actionstring required

Action taken: instant_access | wait_for_indexing | not_indexed | use_private | indexing_started

messagestring required

Human-readable description of the action

global_source_idstring nullable

Canonical ID of the global source

namespacestring nullable

TurboPuffer namespace for the source

statusstring nullable

Current status of the global source

local_reference_idstring nullable

ID of the created local reference (project/data_source)

display_namestring nullable

Display name of the source