Get Job Detail

Get Job Detail

curl --request GET \
  --url https://api.woodwide.ai/jobs/{job_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.woodwide.ai/jobs/{job_id}', 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://api.woodwide.ai/jobs/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.woodwide.ai/jobs/{job_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.woodwide.ai/jobs/{job_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "job_id": "c3d4e5f6-0000-0000-0000-000000000003",
  "type": "train",
  "status": "succeeded",
  "created_at": "2025-01-15T10:00:00Z",
  "started_at": "2025-01-15T10:00:05Z",
  "finished_at": "2025-01-15T10:05:30Z",
  "progress": 100,
  "woodwide_runtime_version": "0.1",
  "credits_consumed": 12.5
}

{
  "detail": "Not authenticated"
}

{
  "detail": "Forbidden"
}

{
  "detail": "Not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "Rate limit exceeded. Retry after a short delay."
}

GET

jobs

{job_id}

Get Job Detail

curl --request GET \
  --url https://api.woodwide.ai/jobs/{job_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.woodwide.ai/jobs/{job_id}', 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://api.woodwide.ai/jobs/{job_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.woodwide.ai/jobs/{job_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.woodwide.ai/jobs/{job_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "job_id": "c3d4e5f6-0000-0000-0000-000000000003",
  "type": "train",
  "status": "succeeded",
  "created_at": "2025-01-15T10:00:00Z",
  "started_at": "2025-01-15T10:00:05Z",
  "finished_at": "2025-01-15T10:05:30Z",
  "progress": 100,
  "woodwide_runtime_version": "0.1",
  "credits_consumed": 12.5
}

{
  "detail": "Not authenticated"
}

{
  "detail": "Forbidden"
}

{
  "detail": "Not found"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "Rate limit exceeded. Retry after a short delay."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

job_id

string<uuid>

required

Response

Successful Response

Detailed job information.

Extends Job with input/output payloads, typed resource references, error details, and billing information.

string

required

Public ID of the job (e.g. job_A8K2P9QX).

type

string

required

Job type: dataset_ingest, train, infer_sync, or infer_batch.

status

enum<string>

required

Job status: initializing, pending, queued, running, succeeded, failed, canceled, or rejected. For dataset_ingest jobs, may also be 'waiting_for_upload'.

Available options:

initializing,

pending,

queued,

running,

succeeded,

failed,

canceled,

rejected,

waiting_for_upload

created_at

string<date-time>

required

started_at

string<date-time> | null

finished_at

string<date-time> | null

created_by

Created By · object | null

Who created this job: {principal_type, user_id, api_key_id}.

actor_name

string | null

Display name of who created the job: the user's display name (email fallback), or the API key's name for API-key principals. Populated on dashboard-activity rows; null when the creator is unknown.

model_type

string | null

Model task type when applicable (e.g. prediction, clustering, anomaly). Derived from job input or the linked model; null for jobs without a model context.

model_id

string | null

Public ID of the parent model when the job is tied to a model (training, inference); null otherwise.

dataset_id

string | null

Public ID of the dataset when the job references a dataset version (e.g. batch inference on curated data); null for file-only inference and other jobs.

dataset_name

string | null

Display name of the linked dataset when resolved via dataset_version; null when there is no dataset or the name is unavailable.

input_filename

string | null

Original name of the uploaded file for file-backed jobs (sync/async file inference); null when the job referenced a dataset or carries no uploaded file.

parent_job_id

string | null

Public ID of the parent job when this job consumes outputs from it as part of a compound inference/training chain.

input

Input · object | null

output

Output · object | null

resources

IngestResources · object

Resources for a dataset_ingest job.

IngestResources
TrainResources
InferSyncResources
InferBatchResources
ModelExplainResources

Show child attributes

explanations

JobExplanationRow · object[] | null

Inline row explanations for succeeded infer_explain jobs.

Show child attributes

error_message

string | null

Human-readable error message if the job failed.

woodwide_runtime_version

string | null

ML runtime version used for this job.

credits_consumed

number | null

Credits consumed by this job (null if not yet finalized).

progress

number | null

Progress percentage (0-100). For training jobs, tracks training progress.

current_step

integer | null

Current training step (training jobs only). Counts SSL + finetune steps.

total_steps

integer | null

Total training steps planned for this job (training jobs only).

current_phase

enum<string> | null

Current training phase: ssl (self-supervised pre-training) or finetune (supervised head finetune). Training jobs only; null for unsupervised model types that have no training loop.

Available options:

ssl,

finetune

metrics_history

MetricPoint · object[] | null

Bounded series of per-interval training metrics (capped at 200 points, downsampled in place). Training jobs only; null for unsupervised paths and for jobs before the first validation gate.

Show child attributes

Getting Started

Endpoints

Details

Authorizations

Path Parameters

Response