168 lines
7.0 KiB
JSON
168 lines
7.0 KiB
JSON
[
|
|
"Trilium Notes - Sync server API",
|
|
"This is the internal sync server API used by Trilium Notes / TriliumNext Notes.\n\n_If you're looking for the officially supported External Trilium API, see [here](https://triliumnext.github.io/Docs/Wiki/etapi.html)._\n\nThis page does not yet list all routes. For a full list, see the [route controller](https://github.com/TriliumNext/Notes/blob/v0.91.6/src/routes/routes.ts).",
|
|
"Sync documentSecret value",
|
|
"First step to logging in.",
|
|
"Successful operation",
|
|
"List available models from Anthropic",
|
|
"Optional custom Anthropic API base URL",
|
|
"List of available Anthropic models",
|
|
"Error listing models",
|
|
"Get installation info",
|
|
"Server implementation",
|
|
"Installation info",
|
|
"value of process.version",
|
|
"Delete branch (note clone)",
|
|
"Task group identifier",
|
|
"Whether to erase the note immediately",
|
|
"Whether this is the last request of this task group",
|
|
"Branch successfully deleted",
|
|
"Whether the last note clone was deleted",
|
|
"Find similar notes based on a given note ID",
|
|
"Embedding provider ID",
|
|
"Embedding model ID",
|
|
"Maximum number of similar notes to return",
|
|
"Similarity threshold (0.0-1.0)",
|
|
"List of similar notes",
|
|
"Invalid request parameters",
|
|
"Note not found",
|
|
"Search for notes similar to provided text",
|
|
"Text to search with",
|
|
"Get available embedding providers",
|
|
"List of available embedding providers",
|
|
"Update embedding provider configuration",
|
|
"Provider ID to update",
|
|
"Whether provider is enabled",
|
|
"Priority order (lower is higher priority)",
|
|
"Provider-specific configuration",
|
|
"Provider updated successfully",
|
|
"Invalid provider ID or configuration",
|
|
"Reprocess embeddings for all notes",
|
|
"Provider ID to use for reprocessing",
|
|
"Model ID to use for reprocessing",
|
|
"Whether to reprocess notes that already have embeddings",
|
|
"Reprocessing started",
|
|
"Get status of the embedding processing queue",
|
|
"Optional job ID to get status for a specific processing job",
|
|
"Queue status information",
|
|
"Progress percentage (0-100)",
|
|
"Get embedding statistics",
|
|
"Embedding statistics",
|
|
"Get list of notes that failed embedding generation",
|
|
"List of failed notes",
|
|
"Retry generating embeddings for a failed note",
|
|
"Note ID to retry",
|
|
"Provider ID to use (defaults to configured default)",
|
|
"Model ID to use (defaults to provider default)",
|
|
"Retry result",
|
|
"Invalid request",
|
|
"Retry generating embeddings for all failed notes",
|
|
"Retry started",
|
|
"Rebuild the vector store index",
|
|
"Rebuild started",
|
|
"Get status of the vector index rebuild operation",
|
|
"Optional job ID to get status for a specific rebuild job",
|
|
"Rebuild status information",
|
|
"Create a new LLM chat session",
|
|
"Title for the chat session",
|
|
"System message to set the behavior of the assistant",
|
|
"Temperature parameter for the LLM (0.0-1.0)",
|
|
"Maximum tokens to generate in responses",
|
|
"Specific model to use (depends on provider)",
|
|
"LLM provider to use (e.g., 'openai', 'anthropic', 'ollama')",
|
|
"Note ID to use as context for the session",
|
|
"Successfully created session",
|
|
"List all chat sessions",
|
|
"List of chat sessions",
|
|
"Retrieve a specific chat session",
|
|
"Chat session details",
|
|
"Session not found",
|
|
"Delete a chat session",
|
|
"Session successfully deleted",
|
|
"Update a chat's settings",
|
|
"The ID of the chat note (formerly sessionId)",
|
|
"Updated title for the session",
|
|
"Updated system prompt",
|
|
"Updated temperature setting",
|
|
"Updated maximum tokens setting",
|
|
"Updated model selection",
|
|
"Updated provider selection",
|
|
"Updated note ID for context",
|
|
"Session successfully updated",
|
|
"Send a message to an LLM and get a response",
|
|
"The user message to send to the LLM",
|
|
"Optional parameters for this specific message",
|
|
"Whether to include relevant notes as context",
|
|
"Whether to use the session's context note",
|
|
"LLM response",
|
|
"Error processing request",
|
|
"Get stats about the LLM knowledge base indexing status",
|
|
"Index stats successfully retrieved",
|
|
"Start or continue indexing the knowledge base",
|
|
"Whether to force reindexing of all notes",
|
|
"Indexing started successfully",
|
|
"Get list of notes that failed to index",
|
|
"Failed indexes successfully retrieved",
|
|
"Retry indexing all failed notes",
|
|
"Retry of all failed indexes successfully initiated",
|
|
"Retry indexing a specific note that previously failed",
|
|
"Index retry successfully initiated",
|
|
"Index a specific note for LLM knowledge base",
|
|
"Note indexed successfully",
|
|
"Find notes similar to a query string",
|
|
"Similar notes found successfully",
|
|
"Generate context for an LLM query based on the knowledge base",
|
|
"Context generated successfully",
|
|
"Stream a message to an LLM via WebSocket",
|
|
"The ID of the chat note to stream messages to (formerly sessionId)",
|
|
"Whether to use advanced context extraction",
|
|
"Whether to show thinking process in the response",
|
|
"Streaming started successfully",
|
|
"Log in using documentSecret",
|
|
"The `hash` parameter is computed using a HMAC of the `documentSecret` and `timestamp`.",
|
|
"HMAC calculation",
|
|
"Sync version / document secret mismatch",
|
|
"Timestamp mismatch",
|
|
"Retrieve note metadata",
|
|
"Note metadata",
|
|
"Delete note",
|
|
"Note successfully deleted",
|
|
"Retrieve note content",
|
|
"Note content",
|
|
"Retrieve note metadata (limited to timestamps)",
|
|
"List available models from Ollama",
|
|
"Optional custom Ollama API base URL",
|
|
"List of available Ollama models",
|
|
"List available models from OpenAI",
|
|
"Optional custom OpenAI API base URL",
|
|
"List of available OpenAI models",
|
|
"Pull sync changes",
|
|
"Local instance ID",
|
|
"Last locally present change ID",
|
|
"Marker to identify this request in server log",
|
|
"Sync changes, limited to approximately one megabyte.",
|
|
"If `outstandingPullCount > 0`, pass this as parameter in your next request to continue.",
|
|
"Number of changes not yet returned by the remote.",
|
|
"Push sync changes",
|
|
"Basic usage: set `pageCount = 1`, `pageIndex = 0`, and omit `requestId`. Supply your entity changes in the request body.",
|
|
"ID to identify paginated requests",
|
|
"Changes processed successfully",
|
|
"Retrieve tree data",
|
|
"Limit tree data to this note and descendants",
|
|
"Notes, branches and attributes",
|
|
"Log in using password",
|
|
"This will give you a Trilium session, which is required for some other API endpoints. `totpToken` is only required if the user configured TOTP authentication.",
|
|
"Password / TOTP mismatch",
|
|
"If type = \"relation\", a note ID. Otherwise, the attribute content.",
|
|
"`null` if not text.",
|
|
"Equal to `{parentNoteId}_{noteId}`",
|
|
"Database table for this entity.",
|
|
"ID, referenced in `entity_changes` table.",
|
|
"Encoded entity data. Object has one property for each database column.",
|
|
"[Reference list](https://github.com/TriliumNext/Notes/blob/v0.91.6/src/services/note_types.ts)",
|
|
"12-character note ID. Special values: \"none\"`, `\"root\".",
|
|
"Result of `new Date().toISOString().replace('T', ' ')`",
|
|
"Username and password, formatted as `user:password`",
|
|
"Authentication",
|
|
"Synchronization"
|
|
] |