Hey, human!
HTTP/2 200 OK content-type: text/markdown; charset=utf-8 vary: accept, user-agent x-agent: [ai_agent]
Loading the agent response…
Search the words inside the library's files; returns the best matching passages with file id, page and a snippet
Finds the passages of the workspace's files (PDF, Word, text, Markdown, subtitles) that best match the words of q. Each result has file_id, name, folder_id, page (PDFs) and a snippet; coverage says how many files exist, were searched, cannot be searched as text (pictures, audio, video, scans) or are still waiting to be read (call again to continue). Only files the token's person can open are searched. No model runs and no credits are used. It counts as a search request: 5 units of the organization's daily quota and the plan's search and AI limit a minute per key. Needs files:read.
Do this with AI
I want to search the words inside the library's files; returns the best matching passages with file id, page and a snippet. Use the Tarkle API. Read the reference for this operation and follow it exactly: https://project-03b42162.restlessdocs.com/endpoint/searchfiles.md Authenticate with your API key as a Bearer token in the Authorization header. Then make the request for me and tell me what came back.
Paste this into Claude, Cursor, or any AI assistant and it will do it for you.
https://tarkle.com/api/v1/files/searchcurl --request GET \
--url 'https://tarkle.com/api/v1/files/search?q=q' \
--header 'Authorization: Bearer $API_KEY' \
--header 'X-Workspace-Key: X-Workspace-Key'Query parameters
qstringrequiredThe words to look for (up to 500 characters)
folderstring · uuidOnly search inside this folder and its subfolders (a folder id)
limitinteger1 to 20, default 8
workspace_keystringThe same key as the X-Workspace-Key header, for clients that cannot set headers. Send one of the two, or both with the same value (different values are 400 conflicting_workspace)
Header parameters
X-Workspace-KeystringrequiredThe 8-character key of the workspace this call acts on; GET /workspaces lists the keys a token can use. A workspace id is refused (400 workspace_key_required)