Authentication

SourceSync uses API keys to authenticate requests and tenant headers for data isolation.

API Keys

Get your API key by subscribing on our pricing page. After subscription, you'll receive your API key via email. Include it in the Authorization header for all API requests:

Authorization: Bearer your_api_key

Tenant Header

SourceSync optionally supports multitenancy through the X-Tenant-ID header. This header is only required if you need to isolate data between different tenants in your application. When provided, this header ensures automatic data isolation between tenants:

X-Tenant-ID: tenant-123

Usage Guidelines

1. Format:

   • Use URL-safe characters (alphanumeric, hyphens, underscores)
   • Keep IDs short but meaningful
   • Maximum length: 64 characters
   • Example: tenant-123, org-456-dept-789

2. Behavior:

   • All document operations are automatically scoped to the tenant
   • Search results only include documents from the specified tenant
   • Document management operations are tenant-isolated

Example Request

curl -X POST "https://api.sourcesync.ai/v1/search" \
  -H "Authorization: Bearer $RAGAAS_API_KEY" \
  -H "X-Tenant-ID: tenant-123" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "security policy",
    "namespaceId": "shared-namespace"
  }'

Making Requests

Example of an authenticated request:

curl -X GET "https://api.sourcesync.ai/v1/ingest-job-runs/ijr_abc123?namespaceId=ns_abc123" \
  -H "Authorization: Bearer $RAGAAS_API_KEY"

Error Responses

Rate Limits

The API has the following rate limits:

Rate limit headers are included in all responses:

X-RateLimit-Limit: 200       # Your current rate limit
X-RateLimit-Remaining: 199   # Requests remaining
X-RateLimit-Reset: 1640995200 # Timestamp when limit resets