API Reference

Job Iterations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get job iteration

job_iterations.retrieve(strid) -> JobIterationRetrieveResponse

GET/api/job-iterations/{id}/

Get job iteration

ParametersExpand Collapse

id: str

formatuuid

ReturnsExpand Collapse

class JobIterationRetrieveResponse: …

id: str

formatuuid

created_at: datetime

formatdate-time

iteration_name: str

maxLength64

job: str

formatuuid

agent_code: Optional[str]

avg_score: Optional[float]

formatdouble

description: Optional[str]

dimension_scores: Optional[object]

order: Optional[int]

maximum9223372036854776000

minimum-9223372036854776000

formatint64

status: Optional[Literal["keep", "discard"]]

• keep - Keep
• discard - Discard

Accepts one of the following:

"keep"

"discard"

Get job iteration

Python

HTTP

TypeScript

Python

from overmind_lab import OvermindLab

client = OvermindLab()
job_iteration = client.job_iterations.retrieve(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(job_iteration.id)

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "iteration_name": "iteration_name",
  "job": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent_code": "agent_code",
  "avg_score": 0,
  "description": "description",
  "dimension_scores": {},
  "order": -9007199254740991,
  "status": "keep"
}

Returns Examples

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "iteration_name": "iteration_name",
  "job": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent_code": "agent_code",
  "avg_score": 0,
  "description": "description",
  "dimension_scores": {},
  "order": -9007199254740991,
  "status": "keep"
}