Create Collection

Develop Env

https://dev.your-api-server.com

POST

/collections

Create an empty collection

Response:

Similar with POST /documents/upload, response id also called upload_id, which can be used for document related APIs:

GET /documents/{upload_id}

DELETE /documents/{upload_id}

POST /questions?upload_id={upload_id}

Upon created you can add sub documents to the collection by:

POST /documents/upload

POST /collections/clone-documents.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://dev.your-api-server.com/collections' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string"
}'

Response Example

200 - Example 1

{
    "id": "string",
    "status": 1,
    "name": "string",
    "created_at": 0,
    "type": "collection"
}

Request

Body Params application/json

name

string

Name

required

>= 1 characters<= 80 characters

Examples

Responses

🟢200Successful Response

application/json

Body

string

required

status

enum<integer>

required

An enumeration.

Allowed values:

17101215202530405070120902103000-1-2-3-4-5-6-9-10-11-12-13-14-15-16-17-18-19-25

name

string

Name

required

created_at

integer

Created At

required

type

enum<string>

required

An enumeration.

Allowed values:

collectionsingle_docdoc_of_collection

🟠422Validation Error

Modified at 2024-07-26 06:57:23

Download Document

Clone Document To Collection