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/216/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 216,
    "details": "https://api.beluga.insectai.org/api/v2/jobs/216/?format=api",
    "name": "VCE Sample - Luna",
    "delay": 0,
    "limit": 200,
    "shuffle": true,
    "project": {
        "id": 18,
        "name": "Vermont Atlas of Life",
        "details": "https://api.beluga.insectai.org/api/v2/projects/18/?format=api",
        "user_permissions": []
    },
    "deployment": {
        "id": 53,
        "name": "Luna",
        "details": "https://api.beluga.insectai.org/api/v2/deployments/53/?format=api",
        "user_permissions": []
    },
    "source_image_collection": null,
    "source_image_single": null,
    "pipeline": {
        "id": 3,
        "details": "https://api.beluga.insectai.org/api/v2/ml/pipelines/3/?format=api",
        "name": "Quebec & Vermont moths",
        "slug": "quebec_vermont_moths_2023",
        "description": "",
        "version": 1,
        "version_name": "",
        "created_at": "2023-11-27T23:26:16.449157",
        "updated_at": "2026-04-01T17:09:36.520322",
        "user_permissions": []
    },
    "status": "FAILURE",
    "created_at": "2023-12-03T04:56:41.329542",
    "updated_at": "2024-11-13T17:15:35.433800",
    "started_at": null,
    "finished_at": null,
    "duration": null,
    "progress": {
        "summary": {
            "status": "FAILURE",
            "progress": 0.0
        },
        "stages": [
            {
                "status": "CREATED",
                "progress": 0.0,
                "key": "delay",
                "name": "Delay",
                "params": [
                    {
                        "name": "Delay",
                        "key": "delay",
                        "category": "default",
                        "value": 1
                    },
                    {
                        "name": "Mood",
                        "key": "mood",
                        "category": "default",
                        "value": "😴"
                    }
                ]
            },
            {
                "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": "Proccessed",
                        "key": "proccessed",
                        "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": ""
                    }
                ]
            }
        ],
        "errors": [],
        "logs": [
            "[2024-03-24 13:50:00] INFO Changing status of job 216 to FAILURE"
        ]
    },
    "logs": {
        "stdout": [
            "[2024-03-24 13:50:00] INFO Changing status of job 216 to FAILURE"
        ],
        "stderr": []
    },
    "job_type": {
        "name": "ML pipeline",
        "key": "ml"
    },
    "data_export": null,
    "dispatch_mode": "internal",
    "result": null,
    "user_permissions": []
}