📁Groups

List Groups

GET https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups.json

curl -X GET -H "Authorization: Bearer ${SECRET_KEY}" https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups.json

Query Parameters

Name	Type	Description
project_id	String
page	Integer
items	Integer

Headers

Name	Type	Description
Authorization	String	Bearer SECRET_KEY

200: OK Paginated list of Groups

{
    "data": [
        {
            "type": "groups",
            "id": "g-xu49PKim5ztpqxQ5AfRCwC",
            "attributes": {
                "uuid": "c749b981-01a1-4994-95ad-4a2042a25d10~2",
                "status": "ready"
            },
            "relationships": {
                "project": {
                    "data": {
                        "type": "projects",
                        "id": "8a540ce633522d881e97"
                    }
                }
            },
            "authentication": {
                "access_token": "gat-938HYhsrDjFDWpQ4kkG5q2"
            }
        },
        {
            "type": "groups",
            "id": "g-RP5xI91hZYOUWQkQiZW8Y2",
            "attributes": {
                "uuid": "3200b012-8112-4113-828e-ae16bd271057~2",
                "status": "ready"
            },
            "relationships": {
                "project": {
                    "data": {
                        "type": "projects",
                        "id": "8a540ce633522d881e97"
                    }
                }
            },
            "authentication": {
                "access_token": "gat-NJv87JXci9z63zmcnjeBts"
            }
        }
    ],
    "pagination": {
        "count": 2,
        "page": 1,
        "items": 20,
        "pages": 1
    }
}

Create a Group

POST https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups.json

Authentication specifics You can create a Group in your project with or without authentication, depending on how you Project is set up. If you're making a non-authenticated upload, you will get the access token that allows modifications to this specific Group. It could be useful if you're creating this Group on behalf of your user, so you can't share secret keys with them, but want them to access this Group or edit it later, without giving such an access to public.

curl -X POST -H "Authorization: Bearer ${SECRET_KEY}" -H "Content-Type: application/json" -d '{"file_ids": ["${FILE_ID_1}", "${FILE_ID_2}"]}' https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups.json

Path Parameters

Name	Type	Description
project_id*	String

Headers

Name	Type	Description
Authorization	String	Bearer SECRET_KEY

Request Body

Name	Type	Description
file_ids*	Array

200: OK Groups is creating

{
    "data": {
        "type": "groups",
        "id": "g-xu49PKim5ztpqxQ5AfRCwC",
        "attributes": {
            "uuid": null,
            "status": "pending"
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            }
        },
        "authentication": {
            "access_token": "gat-938HYhsrDjFDWpQ4kkG5q2"
        }
    }
}

View Group

GET https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/:group_id.json

Authentication specifics Group can be accessed either by Project's secret key or by Group's access token.

curl -X GET -H "Authorization: Bearer ${SECRET_KEY}" https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/${GROUP_ID}.json

Path Parameters

Name	Type	Description
project_id*	String
group_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET_KEY or Bearer GROUP_ACCESS_TOKEN

200: OK

{
    "data": {
        "type": "groups",
        "id": "g-xu49PKim5ztpqxQ5AfRCwC",
        "attributes": {
            "uuid": "c749b981-01a1-4994-95ad-4a2042a25d10~2",
            "status": "ready"
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            }
        },
        "authentication": {
            "access_token": "gat-938HYhsrDjFDWpQ4kkG5q2"
        }
    }
}

List Group's FIles

GET https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/:group_id/files.json

Authentication specifics Group can be accessed either by Project's secret key or by Group's access token.

curl -X GET -H "Authorization: Bearer ${SECRET_KEY}" https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/${GROUP_ID}/files.json

Path Parameters

Name	Type	Description
project_id*	String
group_id*	String
page	Integer
items	Integer

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET_KEY or Bearer GROUP_ACCESS_TOKEN

200: OK Paginated list of Files

{
    "data": [
        {
            "type": "files",
            "id": "f-pzRscOLZpMNeUjUUlHIwhS",
            "attributes": {
                "uuid": "e3b7bca3-e657-43b8-b8be-b79edf106e47",
                "is_image": true,
                "status": "ready",
                "mime": {
                    "mime": "image/png",
                    "type": "image",
                    "subtype": "png"
                },
                "original_url": "https://ucarecdn.com/e3b7bca3-e657-43b8-b8be-b79edf106e47/SCR20231117qnol.png",
                "original_name": "SCR-20231117-qnol.png",
                "size": 14,
                "chunked_upload": {
                    "is_chunked_upload": false,
                    "chunk_size": null,
                    "is_complete": false
                },
                "metadata": {},
                "content": {
                    "image": {
                        "dpi": [
                            144,
                            144
                        ],
                        "width": 378,
                        "format": "PNG",
                        "height": 352,
                        "sequence": false,
                        "color_mode": "RGBA",
                        "orientation": null,
                        "geo_location": null,
                        "datetime_original": null
                    },
                    "video": {
                        "thumbnails_group_uuid": null
                    }
                },
                "created_at": "2023-11-18T07:36:58.449Z",
                "uploaded_at": "2023-11-18T07:36:57.897038Z",
                "removed_at": null,
                "expires_at": null
            },
            "relationships": {
                "project": {
                    "data": {
                        "type": "projects",
                        "id": "8a540ce633522d881e97"
                    }
                }
            },
            "authentication": {
                "access_token": "fat-pfeERYqeB6CzXHwcNp6B0i"
            },
            "chunked_upload_urls": []
        },
        {
            "type": "files",
            "id": "f-IC3oc8MHjv1WV9iV7DulJI",
            "attributes": {
                "uuid": "49936ae3-a967-4975-92c4-01c6a535c903",
                "is_image": null,
                "status": "pending",
                "mime": null,
                "original_url": null,
                "original_name": "20mb.jpg",
                "size": 15,
                "chunked_upload": {
                    "is_chunked_upload": true,
                    "chunk_size": 10485760,
                    "is_complete": true
                },
                "metadata": {
                    "foo": "bar"
                },
                "content": {
                    "image": null,
                    "video": {
                        "thumbnails_group_uuid": null
                    }
                },
                "created_at": "2023-11-18T07:50:39.587Z",
                "uploaded_at": "2023-11-18T07:50:39.460403Z",
                "removed_at": null,
                "expires_at": null
            },
            "relationships": {
                "project": {
                    "data": {
                        "type": "projects",
                        "id": "8a540ce633522d881e97"
                    }
                }
            },
            "authentication": {
                "access_token": "fat-iAWqPSlSybODKHMiybfxL5"
            },
            "chunked_upload_urls": []
        }
    ],
    "pagination": {
        "count": 2,
        "page": 1,
        "items": 20,
        "pages": 1
    }
}

Update Group

PUT https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/:group_id.json

Authentication specifics Group can be accessed either by Project's secret key or by Group's access token.

curl -X PUT -H "Authorization: Bearer ${SECRET_KEY}" -H "Content-Type: application/json" -d '{"file_ids": ["${FILE_ID_1}", "${FILE_ID_2}"]}' https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/${GROUP_ID}.json

Path Parameters

Name	Type	Description
project_id*	String
group_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET_KEY or Bearer GROUP_ACCESS_TOKEN

Request Body

Name	Type	Description
file_ids*	Array

Delete Group

DELETE https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/:group_id.json

Authentication specifics Group can be accessed either by Project's secret key or by Group's access token.

curl -X DELETE -H "Authorization: Bearer ${SECRET_KEY}" https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/groups/${GROUP_ID}.json

Path Parameters

Name	Type	Description
project_id*	String
group_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET_KEY or Bearer GROUP_ACCESS_TOKEN

200: OK

{
    "data": {
        "type": "groups",
        "id": "g-xu49PKim5ztpqxQ5AfRCwC",
        "attributes": {
            "uuid": "c749b981-01a1-4994-95ad-4a2042a25d10~2",
            "status": "ready"
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            }
        },
        "authentication": {
            "access_token": "gat-938HYhsrDjFDWpQ4kkG5q2"
        }
    }
}