Skip to content

docs: add llms.txt for AI context #1233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SachinMyadam wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add llms.txt for AI context #1233

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Jina Reader API

> The Jina Reader API extracts clean, LLM-friendly text from any URL.

## Base Endpoint
`https://r.jina.ai/`

## Usage
Simply prefix the target URL with the base endpoint.

### Basic Request
GET https://r.jina.ai/<TARGET_URL>

### Example
Input: https://r.jina.ai/https://github.com/jina-ai/reader
Output: Clean Markdown text of the target page.

## Advanced Features
- JSON Mode: Add header `Accept: application/json`
- Search Mode: Use `https://s.jina.ai/<QUERY>`