Skip to main content

Search links

Search links let AI chatbots (like ChatGPT, Claude, or your own) search your knowledge base via public URL.

ScenarioUse search links
Large knowledge base (100+ docs)Perfect
AI needs to find specific answersPerfect
Dynamic Q&A over your docsPerfect
Small set of always-needed docsUse Instruction sets instead

How it works

  1. Create a search link for your workspace
  2. Share the URL with AI or integrate in your app
  3. AI searches your documents and gets relevant chunks
Your documents -> Synjar indexes -> AI searches via URL -> Gets answers
  1. Go to your workspace
  2. Click the Search Links tab
  3. Click Create Search Link
  4. 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:

  1. Tag your documents (e.g., public-facing, internal)
  2. When creating search link, select Only specific tags
  3. Choose allowed tags (e.g., only public-facing)

Now only documents with those tags will be included in search results.

Security

What they CAN doWhat they CANNOT do
Search your documentsEdit or delete documents
Read matched chunksSee full document content
Filter by allowed tagsAccess other workspaces

Best practices

  • Use tag scoping for public-facing links
  • Set expiration for time-limited access
  • Revoke links when no longer needed
FeatureSearch linksInstruction sets
How it worksAI searches on-demandAI loads full content
Document limitUnlimited~20 documents
Use caseQ&A, large KBBrand voice, procedures
Content freshnessAlways currentUpdated on rebuild
tip

You can use both together! Use instruction sets for core instructions and search links for reference material.