NoteApi
valkyrai-api
All URIs are relative to http://localhost:8080/v1
Method | HTTP request | Description |
---|---|---|
deleteNote | DELETE NoteApi | Delete a Note. |
deleteNote
Void
deleteNote(id)
Delete a Note.
Deletes a specific Note.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.NoteApi;
NoteApi apiInstance = new NoteApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Note.
try {
Void result = apiInstance.deleteNote(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NoteApi#deleteNote");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Unique identifier for the Note. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
getNote
Note
getNote(id)
Retrieve a single Note
Retrieves a single Note for a specific uid.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.NoteApi;
NoteApi apiInstance = new NoteApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Note.
try {
Note result = apiInstance.getNote(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NoteApi#getNote");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Unique identifier for the Note. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
getNoteList
Note
getNoteList(pagesizesort)
Retrieve a list of Notes
Retrieves a list of Notes.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.NoteApi;
NoteApi apiInstance = new NoteApi();
Integer page = 0; // Integer |
Integer size = 20; // Integer |
List<String> sort = Arrays.asList(); // List<String> |
try {
Note result = apiInstance.getNoteList(pagesizesort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NoteApi#getNoteList");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | Integer | [optional] [default to 0] | |
size | Integer | [optional] [default to 20] | |
sort | List<String> | [optional] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
postNote
Note
postNote(note)
Create a new Note
Creates a new Note.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.NoteApi;
NoteApi apiInstance = new NoteApi();
Note note = new Note(); // Note | Note details.
try {
Note result = apiInstance.postNote(note);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NoteApi#postNote");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
note | Note | Note details. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
updateNote
Note
updateNote(idnote)
Update an existing Note
Updates an existing Note.
Example
Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.NoteApi;
NoteApi apiInstance = new NoteApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the Note.
Note note = new Note(); // Note | Updated Note details.
try {
Note result = apiInstance.updateNote(idnote);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NoteApi#updateNote");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | UUID | Unique identifier for the Note. | |
note | Note | Updated Note details. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Generated Version Details
~ | value |
---|---|
GENERATOR VERSION | com.valkyrlabs:ValkyrAI API 1.0.1-SNAPSHOT |
API ARTIFACT | com.valkyrlabs.valkyrai-api.jar |
GENERATOR VERSION | org.openapitools.openapi-generator:7.5.0 |
GENERATOR CLASS | org.openapitools.codegen.languages.SpringCodegen |
GENERATED DATE | 2025-09-03T16:35:42.569765-07:00[America/Los_Angeles] |