> For the complete documentation index, see [llms.txt](https://sugoi.gitbook.io/lanraragi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sugoi.gitbook.io/lanraragi/api-documentation/shinobu-api.md).

# Shinobu API

## 🔑 Get Shinobu status

> Get the current status of the FileWatcher.

```json
{"openapi":"3.1.0","info":{"title":"LANraragi API","version":"0.9.6"},"tags":[{"name":"shinobu","description":"Shinobu Filewatcher APIs."}],"servers":[{"url":"https://lrr.tvc-16.science/api"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header","description":"Use Authorization: Bearer <base64(api_key)>"}}},"paths":{"/shinobu":{"get":{"operationId":"shinobuStatus","summary":"🔑 Get Shinobu status","description":"Get the current status of the FileWatcher.","tags":["shinobu"],"responses":{"200":{"description":"Status","content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"string","enum":["shinobu_status"]},"success":{"type":"integer","enum":[0,1]},"is_alive":{"type":"integer","enum":[0,1]},"pid":{"type":"integer","description":"Current PID of the Watcher process"}}}}}}}}}}}
```

## 🔑 Stop Shinobu

> Stops the Filewatcher. Use \`/api/shinobu/restart\` to start it again.

```json
{"openapi":"3.1.0","info":{"title":"LANraragi API","version":"0.9.6"},"tags":[{"name":"shinobu","description":"Shinobu Filewatcher APIs."}],"servers":[{"url":"https://lrr.tvc-16.science/api"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header","description":"Use Authorization: Bearer <base64(api_key)>"}},"schemas":{"OperationResponse":{"type":"object","required":["operation","success"],"properties":{"operation":{"type":"string","description":"Name of operation"},"error":{"type":"string","description":"Error message if any"},"successMessage":{"type":"string","description":"Success message if any"},"success":{"type":"integer","description":"Returns 1 if operation was successful, else 0","enum":[0,1]}}}}},"paths":{"/shinobu/stop":{"post":{"operationId":"shinobuStop","summary":"🔑 Stop Shinobu","description":"Stops the Filewatcher. Use `/api/shinobu/restart` to start it again.","tags":["shinobu"],"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}}}}}}
```

## 🔑 Restart Shinobu

> Restart the Shinobu filewatcher

```json
{"openapi":"3.1.0","info":{"title":"LANraragi API","version":"0.9.6"},"tags":[{"name":"shinobu","description":"Shinobu Filewatcher APIs."}],"servers":[{"url":"https://lrr.tvc-16.science/api"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header","description":"Use Authorization: Bearer <base64(api_key)>"}}},"paths":{"/shinobu/restart":{"post":{"operationId":"shinobuRestart","summary":"🔑 Restart Shinobu","description":"Restart the Shinobu filewatcher","tags":["shinobu"],"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"string","enum":["shinobu_restart"]},"success":{"type":"integer","enum":[0,1]},"new_pid":{"type":"integer","description":"PID of the new Watcher process."}}}}}}}}}}}
```

## 🔑 Rescan filemap and restart Shinobu

> This deletes the internal map of scanned files on your system (the "filemap") and restarts Shinobu, effectively prompting a full rescan of your FS.

```json
{"openapi":"3.1.0","info":{"title":"LANraragi API","version":"0.9.6"},"tags":[{"name":"shinobu","description":"Shinobu Filewatcher APIs."}],"servers":[{"url":"https://lrr.tvc-16.science/api"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header","description":"Use Authorization: Bearer <base64(api_key)>"}}},"paths":{"/shinobu/rescan":{"post":{"operationId":"shinobuRescan","summary":"🔑 Rescan filemap and restart Shinobu","description":"This deletes the internal map of scanned files on your system (the \"filemap\") and restarts Shinobu, effectively prompting a full rescan of your FS.","tags":["shinobu"],"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"string","enum":["shinobu_rescan"]},"success":{"type":"integer","enum":[0,1]},"new_pid":{"type":"integer","description":"PID of the new Watcher process."}}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://sugoi.gitbook.io/lanraragi/api-documentation/shinobu-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.