🔧Actions

Image recognition

Run Image recognition Action

POST https://uc.alxgsv.com/api/v1/projects/:project_id/files/:file_id/actions/recognize.json

curl -X POST -H "Authorization: Bearer ${SECRET_KEY}" https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/files/${FILE_ID}/actions/recognize.json

Path Parameters

Name	Type	Description
project_id*	String
file_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET KEY

200: OK Pending recognize Action result

{
    "data": {
        "type": "actions",
        "id": "a-01MuE23uyawZ4jh50sgYiM",
        "attributes": {
            "action_type": "recognize",
            "status": "pending",
            "result": null
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            },
            "file": {
                "data": {
                    "type": "files",
                    "id": "f-lw1KJfuk8nS6P0Vwl1I4Hw"
                }
            }
        }
    }
}

View Image recognition Action

GET https://uc.alxgsv.com/api/v1/projects/:project_id/files/:file_id/actions/recognize.json

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

Path Parameters

Name	Type	Description
project_id*	String
file_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET_KEY

200: OK Recognize Action with ready status

{
    "data": {
        "type": "actions",
        "id": "a-01MuE23uyawZ4jh50sgYiM",
        "attributes": {
            "action_type": "recognize",
            "status": "ready",
            "result": {
                "data": {
                    "Labels": [
                        {
                            "Name": "City",
                            "Parents": [],
                            "Instances": [],
                            "Confidence": 100
                        },
                        {
                            "Name": "Cityscape",
                            "Parents": [
                                {
                                    "Name": "Architecture"
                                },
                                {
                                    "Name": "Building"
                                },
                                {
                                    "Name": "Urban"
                                }
                            ],
                            "Instances": [],
                            "Confidence": 99.99995422363281
                        },
                        {
                            "Name": "Metropolis",
                            "Parents": [
                                {
                                    "Name": "City"
                                },
                                {
                                    "Name": "Urban"
                                }
                            ],
                            "Instances": [],
                            "Confidence": 99.99995422363281
                        },
                        {
                            "Name": "Urban",
                            "Parents": [],
                            "Instances": [],
                            "Confidence": 99.99995422363281
                        },
                        {
                            "Name": "Scenery",
                            "Parents": [
                                {
                                    "Name": "Nature"
                                },
                                {
                                    "Name": "Outdoors"
                                }
                            ],
                            "Instances": [],
                            "Confidence": 99.81243133544922
                        },
                        {
                            "Name": "Downtown",
                            "Parents": [
                                {
                                    "Name": "City"
                                },
                                {
                                    "Name": "Urban"
                                }
                            ],
                            "Instances": [],
                            "Confidence": 99.80464935302734
                        },
                        {
                            "Name": "Office Building",
                            "Parents": [
                                {
                                    "Name": "Architecture"
                                },
                                {
                                    "Name": "Building"
                                }
                            ],
                            "Instances": [],
                            "Confidence": 99.53872680664062
                        },
                        {
                            "Name": "Waterfront",
                            "Parents": [
                                {
                                    "Name": "Water"
                                }
                            ],
                            "Instances": [],
                            "Confidence": 99.43653106689453
                        },
                        {
                            "Name": "Boat",
                            "Parents": [
                                {
                                    "Name": "Transportation"
                                },
                                {
                                    "Name": "Vehicle"
                                }
                            ],
                            "Instances": [
                                {
                                    "Confidence": 99.13676452636719,
                                    "BoundingBox": {
                                        "Top": 0.5943900346755981,
                                        "Left": 0.9256475567817688,
                                        "Width": 0.07435241341590881,
                                        "Height": 0.036761846393346786
                                    }
                                },
                                {
                                    "Confidence": 87.77543640136719,
                                    "BoundingBox": {
                                        "Top": 0.6204043030738831,
                                        "Left": 0.7094534039497375,
                                        "Width": 0.044370606541633606,
                                        "Height": 0.02026907540857792
                                    }
                                }
                            ],
                            "Confidence": 99.13676452636719
                        },
                        {
                            "Name": "Arch",
                            "Parents": [
                                {
                                    "Name": "Architecture"
                                }
                            ],
                            "Instances": [],
                            "Confidence": 98.2360610961914
                        }
                    ],
                    "LabelModelVersion": "3.0"
                },
                "datetime_created": "2023-11-26T09:15:53.221057Z",
                "datetime_updated": "2023-11-26T09:15:53.221077Z",
                "version": "2016-06-27"
            }
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            },
            "file": {
                "data": {
                    "type": "files",
                    "id": "f-lw1KJfuk8nS6P0Vwl1I4Hw"
                }
            }
        }
    }
}

Image moderation

Run Image moderation Action

POST https://uc.alxgsv.com/api/v1/projects/:project_id/files/:file_id/actions/moderate.json

curl -X POST -H "Authorization: Bearer ${SECRET_KEY}" https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/files/${FILE_ID}/actions/moderate.json

Path Parameters

Name	Type	Description
project_id*	String
file_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET KEY

200: OK Moderate Action with pending status

{
    "data": {
        "type": "actions",
        "id": "a-01MuE23uyawZ4jh50sgYiM",
        "attributes": {
            "action_type": "recognize",
            "status": "pending",
            "result": null
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            },
            "file": {
                "data": {
                    "type": "files",
                    "id": "f-lw1KJfuk8nS6P0Vwl1I4Hw"
                }
            }
        }
    }
}

View Image moderation Action

GET https://uc.alxgsv.com/api/v1/projects/:project_id/files/:file_id/actions/moderate.json

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

Path Parameters

Name	Type	Description
project_id*	String
file_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET_KEY

200: OK Ready moderate Action result

{
    "data": {
        "type": "actions",
        "id": "a-zDluGFWqP9AHONnep3VoAU",
        "attributes": {
            "action_type": "moderate",
            "status": "ready",
            "result": {
                "data": {
                    "ModerationLabels": [],
                    "ModerationModelVersion": "6.1"
                },
                "datetime_created": "2023-11-26T09:48:33.094070Z",
                "datetime_updated": "2023-11-26T09:48:33.094093Z",
                "version": "2016-06-27"
            }
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            },
            "file": {
                "data": {
                    "type": "files",
                    "id": "f-lw1KJfuk8nS6P0Vwl1I4Hw"
                }
            }
        }
    }
}

Virus scan

Run Virus scan action

POST https://uc.alxgsv.com/api/v1/projects/:project_id/files/:file_id/actions/virus_scan.json

curl -X POST -H "Authorization: Bearer ${SECRET_KEY}" https://uc.alxgsv.com/api/v1/projects/${PROJECT_ID}/files/${FILE_ID}/actions/virus_scan.json

Path Parameters

Name	Type	Description
project_id*	String
file_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET KEY

200: OK Virus scan Action with pending status

{
    "data": {
        "type": "actions",
        "id": "a-01MuE23uyawZ4jh50sgYiM",
        "attributes": {
            "action_type": "virus_scan",
            "status": "pending",
            "result": null
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            },
            "file": {
                "data": {
                    "type": "files",
                    "id": "f-lw1KJfuk8nS6P0Vwl1I4Hw"
                }
            }
        }
    }
}

View Virus scan action

GET https://uc.alxgsv.com/api/v1/projects/:project_id/files/:file_id/actions/virus_scan.json

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

Path Parameters

Name	Type	Description
project_id*	String
file_id*	String

Headers

Name	Type	Description
Authorization*	String	Bearer SECRET_KEY

200: OK Virus scan Action with ready status

{
    "data": {
        "type": "actions",
        "id": "a-xPJbimEXVarvLPTTval27S",
        "attributes": {
            "action_type": "virus_scan",
            "status": "ready",
            "result": {
                "data": {
                    "infected": false
                },
                "datetime_created": "2023-11-26T09:15:52.122511Z",
                "datetime_updated": "2023-11-26T09:15:52.122533Z",
                "version": "1.0.1"
            }
        },
        "relationships": {
            "project": {
                "data": {
                    "type": "projects",
                    "id": "8a540ce633522d881e97"
                }
            },
            "file": {
                "data": {
                    "type": "files",
                    "id": "f-lw1KJfuk8nS6P0Vwl1I4Hw"
                }
            }
        }
    }
}