Search links
Search links let AI chatbots (like ChatGPT, Claude, or your own) search your knowledge base via public URL.
When to use search links
| Scenario | Use search links |
|---|---|
| Large knowledge base (100+ docs) | Perfect |
| AI needs to find specific answers | Perfect |
| Dynamic Q&A over your docs | Perfect |
| Small set of always-needed docs | Use Instruction sets instead |
How it works
- Create a search link for your workspace
- Share the URL with AI or integrate in your app
- AI searches your documents and gets relevant chunks
Your documents -> Synjar indexes -> AI searches via URL -> Gets answers
Creating a search link
- Go to your workspace
- Click the Search Links tab
- Click Create Search Link
- Configure:
- Name (optional): For your reference, e.g., "Support KB"
- Scope: All documents or specific tags
- Expiration: Never or specific date
Using with ChatGPT or Claude
After creating a search link, you can use it directly with AI assistants that have browsing capability:
Browse https://api.synjar.com/public/YOUR_TOKEN/search
and search for: What is your refund policy?
Example prompt
You have access to our knowledge base via Synjar semantic search API.
To search, use: https://api.synjar.com/public/abc123/search?q=YOUR_QUERY
Replace YOUR_QUERY with URL-encoded search terms. Examples:
- ?q=refund+policy
- ?q=how+to+reset+password
The API returns JSON with relevant document chunks and relevance scores.
Use this to answer questions about our products and services.
Using in your application
For developers building custom integrations:
const response = await fetch(
'https://api.synjar.com/public/YOUR_TOKEN/search?q=refund+policy'
);
const { results } = await response.json();
// results contains matching document chunks with scores
results.forEach(result => {
console.log(result.title, result.score);
console.log(result.content);
});
See the API Reference for full documentation.
Limiting access with tags
To restrict which documents are searchable:
- Tag your documents (e.g.,
public-facing,internal) - When creating search link, select Only specific tags
- Choose allowed tags (e.g., only
public-facing)
Now only documents with those tags will be included in search results.
Security
| What they CAN do | What they CANNOT do |
|---|---|
| Search your documents | Edit or delete documents |
| Read matched chunks | See full document content |
| Filter by allowed tags | Access other workspaces |
Best practices
- Use tag scoping for public-facing links
- Set expiration for time-limited access
- Revoke links when no longer needed
Search links vs instruction sets
| Feature | Search links | Instruction sets |
|---|---|---|
| How it works | AI searches on-demand | AI loads full content |
| Document limit | Unlimited | ~20 documents |
| Use case | Q&A, large KB | Brand voice, procedures |
| Content freshness | Always current | Updated on rebuild |
tip
You can use both together! Use instruction sets for core instructions and search links for reference material.