GET

Job Instance

API endpoint that allows jobs to be viewed or edited.

Pass the start_now url parameter to the POST method to enqueue the job immediately.

Use the delay field to create a test job with fake duration of work (in seconds).

Actions

/jobs/{id}/run/ (POST)

Run a job (add it to the queue).

/jobs/{id}/cancel/ (POST)

Cancel a job (terminate the background task)

GET /api/v2/jobs/655/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 655,
    "details": "https://api.beluga.insectai.org/api/v2/jobs/655/?format=api",
    "name": "Sync captures for deployment 123",
    "delay": 0,
    "limit": 100,
    "shuffle": true,
    "project": {
        "id": 45,
        "name": "AMBER - Costa Rica",
        "details": "https://api.beluga.insectai.org/api/v2/projects/45/?format=api",
        "user_permissions": []
    },
    "deployment": {
        "id": 123,
        "name": "Costa Rica - Restoration",
        "details": "https://api.beluga.insectai.org/api/v2/deployments/123/?format=api",
        "user_permissions": []
    },
    "source_image_collection": null,
    "source_image_single": null,
    "pipeline": null,
    "status": "SUCCESS",
    "created_at": "2024-05-01T22:46:52.300513",
    "updated_at": "2024-11-13T17:15:34.164114",
    "started_at": "2024-05-01T22:46:53.373729",
    "finished_at": "2024-05-01T22:46:58.694767",
    "duration": "5.321038",
    "progress": {
        "summary": {
            "status": "SUCCESS",
            "progress": 0.3333333333333333
        },
        "stages": [
            {
                "status": "CREATED",
                "progress": 0.0,
                "key": "collect",
                "name": "Collect",
                "params": [
                    {
                        "name": "Total Images",
                        "key": "total_images",
                        "category": "default",
                        "value": ""
                    }
                ]
            },
            {
                "status": "CREATED",
                "progress": 0.0,
                "key": "process",
                "name": "Process",
                "params": [
                    {
                        "name": "Processed",
                        "key": "processed",
                        "category": "default",
                        "value": ""
                    },
                    {
                        "name": "Remaining",
                        "key": "remaining",
                        "category": "default",
                        "value": ""
                    },
                    {
                        "name": "Detections",
                        "key": "detections",
                        "category": "default",
                        "value": ""
                    },
                    {
                        "name": "Classifications",
                        "key": "classifications",
                        "category": "default",
                        "value": ""
                    }
                ]
            },
            {
                "status": "CREATED",
                "progress": 0.0,
                "key": "results",
                "name": "Results",
                "params": [
                    {
                        "name": "Objects created",
                        "key": "objects_created",
                        "category": "default",
                        "value": ""
                    }
                ]
            },
            {
                "status": "SUCCESS",
                "progress": 1.0,
                "key": "data_storage_sync",
                "name": "data_storage_sync",
                "params": [
                    {
                        "name": "total_images",
                        "key": "total_images",
                        "category": "default",
                        "value": 0
                    },
                    {
                        "name": "total_files",
                        "key": "total_files",
                        "category": "default",
                        "value": 3419
                    }
                ]
            },
            {
                "status": "CREATED",
                "progress": 0.0,
                "key": "data_storage_sync",
                "name": "data_storage_sync",
                "params": []
            },
            {
                "status": "CREATED",
                "progress": 1.0,
                "key": "save_and_regroup",
                "name": "save_and_regroup",
                "params": []
            }
        ],
        "errors": [],
        "logs": [
            "[2024-05-01 22:46:58] INFO Finished job #655 \"Sync captures for deployment 123\" (SUCCESS) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Changing status of job 655 to SUCCESS NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Finished syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Saving and recalculating sessions for deployment NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Processed 3419 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:57] INFO Processed 3000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:55] INFO Processed 2000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:54] INFO Processed 1000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:53] INFO Syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:53] INFO Changing status of job 655 to STARTED NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:53] INFO Running job #655 \"Sync captures for deployment 123\" (PENDING) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|"
        ]
    },
    "logs": {
        "stdout": [
            "[2024-05-01 22:46:58] INFO Finished job #655 \"Sync captures for deployment 123\" (SUCCESS) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Changing status of job 655 to SUCCESS NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Finished syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Saving and recalculating sessions for deployment NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:58] INFO Processed 3419 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:57] INFO Processed 3000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:55] INFO Processed 2000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:54] INFO Processed 1000 files NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:53] INFO Syncing captures for deployment #123 Costa Rica - Restoration NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:53] INFO Changing status of job 655 to STARTED NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|",
            "[2024-05-01 22:46:53] INFO Running job #655 \"Sync captures for deployment 123\" (PENDING) NR-LINKING|MzUxNDA2MHxBUE18QVBQTElDQVRJT058MTA1NTk1NTg3NQ|8dcf1144a50a|16f84a26cd40a180a13b9a27c0179f7a|cd13d7bfdf97635c|AMI%20Backend%20%28Staging%29|"
        ],
        "stderr": []
    },
    "job_type": {
        "name": "Unknown",
        "key": "unknown"
    },
    "data_export": null,
    "dispatch_mode": "internal",
    "result": null,
    "user_permissions": []
}