Docs
Sources API

Sources API

The Sources API allows you to manage and interact with content sources in Tatry

Available Endpoints

MethodEndpointDescription
GET/v1/sourcesList all available content sources
GET/v1/sources/{source_id}Get detailed information about a specific source

List Sources

Lists all available content sources.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.tatry.dev/v1/sources
from tatry import TatryRetriever
 
# Initialize the client with your API key
client = TatryRetriever(api_key="your-api-key")
 
# List all sources
sources = client.list_sources()

Query Parameters

ParameterTypeDescription
typestringFilter by source type (free/premium)
statusstringFilter by status (active/inactive)
limitintegerMaximum number of sources to return
offsetintegerPagination offset

Response

{
	"status": "success",
	"data": {
		"sources": [
			{
				"id": "wikipedia",
				"name": "Wikipedia",
				"type": "free",
				"status": "active",
				"description": "Wikipedia content source",
				"coverage": ["general", "academic"],
				"update_frequency": "daily"
			}
		],
		"total": 1
	}
}

Get Source Details

Retrieves detailed information about a specific source.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.tatry.dev/v1/sources/wikipedia
from tatry import TatryRetriever
 
# Initialize the client with your API key
client = TatryRetriever(api_key="your-api-key")
 
# Get details for a specific source
source = client.get_source("wikipedia")

Response

{
	"status": "success",
	"data": {
		"id": "wikipedia",
		"name": "Wikipedia",
		"type": "free",
		"status": "active",
		"description": "Wikipedia content source",
		"coverage": ["general", "academic"],
		"update_frequency": "daily",
		"metadata": {
			"content_quality_score": 0.95,
			"total_documents": 6500000,
			"languages": ["en", "es", "fr", "de"]
		}
	}
}

Error Responses

source_not_found (404)

Specified source does not exist.

{
	"status": "error",
	"error": {
		"code": "source_not_found",
		"message": "Specified source does not exist",
		"details": {
			"source_id": "invalid_source"
		}
	}
}

Next Steps