Skip to content
Overmind
Get started
API Reference
Jobs

List jobs

client.jobs.list(JobListParams { agent, analyzer_model, created_after, 11 more } query?, RequestOptionsoptions?): JobListResponse { count, results, next, previous }
GET/api/jobs/

List jobs

ParametersExpand Collapse
query: JobListParams { agent, analyzer_model, created_after, 11 more }
agent?: string
formatuuid
analyzer_model?: string
created_after?: string
formatdate-time
created_before?: string
formatdate-time
data_source?: string
job_type?: "inference" | "judge_scoring" | "model_backtesting" | 2 more
  • inference - Inference
  • uploaded_outputs_setup - Uploaded Outputs Setup
  • judge_scoring - Judge Scoring
  • prompt_tuning - Prompt Tuning
  • model_backtesting - Model Backtesting
Accepts one of the following:
"inference"
"judge_scoring"
"model_backtesting"
"prompt_tuning"
"uploaded_outputs_setup"
ordering?: string

Which field to use when ordering the results.

page?: number

A page number within the paginated result set.

project?: string
formatuuid
prompt_slug?: string
score_max?: number
formatfloat
score_min?: number
formatfloat
status?: "cancelled" | "completed" | "failed" | 2 more
  • pending - Pending
  • running - Running
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
Accepts one of the following:
"cancelled"
"completed"
"failed"
"pending"
"running"
ReturnsExpand Collapse
JobListResponse { count, results, next, previous }
count: number
results: Array<Result>
id: string
formatuuid
created_at: string
formatdate-time
updated_at: string
formatdate-time
agent?: string | null
formatuuid
analyzer_model?: string
maxLength128
baseline_score?: number | null
formatdouble
best_score?: number | null
formatdouble
improvement?: number | null
formatdouble
job_type?: "inference" | "uploaded_outputs_setup" | "judge_scoring" | 2 more
  • inference - Inference
  • uploaded_outputs_setup - Uploaded Outputs Setup
  • judge_scoring - Judge Scoring
  • prompt_tuning - Prompt Tuning
  • model_backtesting - Model Backtesting
Accepts one of the following:
"inference"
"uploaded_outputs_setup"
"judge_scoring"
"prompt_tuning"
"model_backtesting"
num_iterations?: number
maximum9223372036854776000
minimum-9223372036854776000
formatint64
project?: string | null
formatuuid
prompt_slug?: string
maxLength255
status?: "pending" | "running" | "completed" | 2 more
  • pending - Pending
  • running - Running
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
Accepts one of the following:
"pending"
"running"
"completed"
"failed"
"cancelled"
List jobs
import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const jobs = await client.jobs.list();

console.log(jobs.count);
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "analyzer_model": "analyzer_model",
      "baseline_score": 0,
      "best_score": 0,
      "improvement": 0,
      "job_type": "inference",
      "num_iterations": -9007199254740991,
      "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "prompt_slug": "prompt_slug",
      "status": "pending"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}
Returns Examples
{
  "count": 123,
  "results": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "agent": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "analyzer_model": "analyzer_model",
      "baseline_score": 0,
      "best_score": 0,
      "improvement": 0,
      "job_type": "inference",
      "num_iterations": -9007199254740991,
      "project": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "prompt_slug": "prompt_slug",
      "status": "pending"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}