1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
---
id: create-a-new-list
title: "Create a new list"
description: "Create a new list"
sidebar_label: "Create a new list"
hide_title: true
hide_table_of_contents: true
api: eJy1VU1v2zAM/SsGz1o+hp58S4sN6FZgxZphhyAHxmYSNbakSnLbwNB/Hyg7sZN6KQZ0F8OSSJF875GqISeXWWm81ApSuLGEnhJMFL0khXQeBHjcOEgXcCedd7AU4CirrPR7SBc1rAgt2Vnlt5AulmEpwNJTRc5f63wPaX0WYL6leG/idZLFYCAg08qT8myNxhQyQ7YePzp2qcFlWyqR//zeEKSgV4+UcWrGakPWS3J8qrCknpXzVqoNCCiluiO14QynAkp8PayuJkGc5nfReXLiPJ2wt8yG3IJoN97eR6oqGc0SVYUFCHAlWs+w5rTGqvCQHs6CgKeK7P69moIAg5aUv82HTFVVFLgqCFJvKwqhYUhayjmPCFpbxzKE5tgZrVwD6ufJdJjFhr38oJIP4lAOlBDEX6h9n72z2i/w9Q8I/ndyLzMmcxAntPWSXwrw0rNnbFdoCL2aTN5yeI150rbqx9GX6XyYp5Kcw83Q2Vl18YbOPkoy+vutziEFo2O+Bln6MC7iUOKZZJ/JujiSKltACjXmuSXnwhiNHD9PQcAzWsm4xlTb4waYAzlb741Lx2Nv96MdWtwRmREaA2KgA9obEr1O/JaS76190uTC2PeG5QMj2ETuj8wjHByZ64hmkLZGINqfr9qWyBl++z2PmDEzP7tJ++UVS1NQNwY7NZ0mftxuOqFbt3kcpduqszPoOqTHq1RrzUEZ/CbAdDQZTaDT4RGW2f3tIIyz+9tkre0phow5d6V2vkTVK2vohTobAkctDz9nTZ2eXv3YFCgVx4mSqVtVLaA4PHVbVlu6gLpeoaNftgiBt1tsFstOU/H1E7AlzMlGGe6I4btpkvk057BsXlQc/k2TBXHwmGUZGX/RdtlriPsfD3OWSfvclrEDweILiPhNAQToCE5UX9yroUC1qWJHQnMniwpPNXmmwVhVe4Rq38uwrhuLud6RCgFEW4rnNQRu4j9RGN5l
sidebar_class_name: "post api-method"
info_path: API/karakeep-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a new list"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/lists"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new list
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"description":"The list to create","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":40},"description":{"type":"string","minLength":0,"maxLength":100},"icon":{"type":"string"},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","minLength":1},"parentId":{"type":"string","nullable":true}},"required":["name","icon"]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"The created list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true}},"required":["id","name","icon","parentId"],"title":"List"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
