Authorizations
Your unique Avido API key
Body
application/json
Request body for creating a new folder
Response
Folder created successfully
Successful response containing the folder data
curl --request POST \
--url https://api.avidoai.com/v0/documents/folders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "API Documentation",
"description": "Folder containing all API-related documentation",
"color": "#10B981",
"tagIds": [
"456e4567-e89b-12d3-a456-426614174000",
"789e4567-e89b-12d3-a456-426614174000"
]
}'
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"name": "API Documentation",
"description": "Folder containing all API-related documentation",
"color": "#10B981",
"tagIds": [
"456e4567-e89b-12d3-a456-426614174000",
"789e4567-e89b-12d3-a456-426614174000"
],
"documentCount": 15
}
}
Creates a new document folder with tag-based membership rules. Documents matching the specified tags will automatically be included.
curl --request POST \
--url https://api.avidoai.com/v0/documents/folders \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "API Documentation",
"description": "Folder containing all API-related documentation",
"color": "#10B981",
"tagIds": [
"456e4567-e89b-12d3-a456-426614174000",
"789e4567-e89b-12d3-a456-426614174000"
]
}'
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"orgId": "org_123456789",
"name": "API Documentation",
"description": "Folder containing all API-related documentation",
"color": "#10B981",
"tagIds": [
"456e4567-e89b-12d3-a456-426614174000",
"789e4567-e89b-12d3-a456-426614174000"
],
"documentCount": 15
}
}
Your unique Avido API key
Request body for creating a new folder
Folder created successfully
Successful response containing the folder data