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/SsGz1qTDD351hYb0K3AijXDDkEOjM0kamVJleS2gaH/PlB2Yif1WgzoLkEs8fO9R6qBknzhpA3SaMjhyhEGyjDT9Jwp6QMICLjxkC/gRvrgYSnAU1E7GXaQLxpYETpyF3XYQr5YxqUAR481+XBpyh3kzUmC+ZZS3CyYrEjJQEBhdCAd2BqtVbJAtp7ce3ZpwBdbqpD/hZ0lyMGs7qng0qwzllyQ5PlWY0UDKx+c1BsQUEl9Q3rDFc4EVPiy/zqfRnFc35vO0yPn2ZS9ZTHmFkV38Doe6bpiNCvUNSoQ4Ct0gWEtaY21CpDv76KAx5rc7r2eogCLjnS4LsdMda0UrhRBHlxNMbYMSUcl15FA6/pYxthee2u0b0H9PJ2Ns9iyV+5V8kEcypEWovgLte+zd9L7G3z9A4L/ndxX+Wy9UrIYmK6MUYQaTtmUJYgjSgeNHcIsBQQZOHyaaWhZP59OXxN9iWXWzfPHcVyYcpzMirzHzdjdSZspQm+fdJv8w9aUkIM1qV6LPB8wUWlz8eJyT+R82lu1U5BDg2XpyPs4QSsnTzMQ8IROMvip1O66BWbP4DYE6/PJJLjd2QM6fCCyZ2gtiJEx6SJkZp2FLWXfO/usrYWxH2zUO0awzTzcqwc4ODP3kcxYBskIRPfnq3EVcoXffs8TZszMz34df3nByirqd2UvuePCD8ftuPTfXR0HfXcS7g36MRrwKvXacFIGv00wO5ueTaHX4QGWi9vrURgvbq+ztXHHGDLmPB3Ghwr1oK2xZ+xkUxy0PP7mtX0GegkTq1BqzpMk03SqWoDav4dbVlu+gKZZoadfTsXIxx02i2WvqfRECtgSluSSDB+I4btqi/k057RsrmpO/2rIoth7XBQF2fCm7XIwELc/7uYsk+5NrtIEgsNnEOk3BxBgEjhJfemsAYV6U6eJhDYmiwqPNXmiwdRVd4V6N6iwaVqLuXkgHSOIrpXA3xB5iP8A4Gbq2Q==
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},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
