Get job status

Get the status for a job.

GET /api/{projectId}/jobs/{jobId}/status

Get job status

cURL

curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status \
  --header 'x-api-key: <api-key>'

import requests

url = "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/{jobId}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "job": {
    "id": 123,
    "category": "<string>",
    "categoryKey": "<string>",
    "key": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "jobNotificationUids": [
      123
    ],
    "started": "2023-11-07T05:31:56Z",
    "finished": "2023-11-07T05:31:56Z",
    "finishedSuccessful": true,
    "additionalInfo": "<string>",
    "computeTime": 123,
    "createdByUser": {
      "id": 123,
      "name": "<string>",
      "username": "<string>",
      "photo": "<string>"
    },
    "categoryCount": 123,
    "metadata": {}
  },
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Path Parameters

projectId · integer · required

Project ID

jobId · integer · required

Job ID

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

job · object · required

Show child attributes

error · string

Optional error description (set if 'success' was false)