AgentOptimizationJobs
List candidates for an agent optimization job
Lists candidates for the given optimization job with cursor pagination, including the original baseline and generated candidates. Each output.mutations item identifies a changed attribute by type; mutation value fields are omitted unless the client passes expand=mutations.
Path parameters
jobId
string
required
The ID of the parent optimization job.
Query parameters
expand
AgentOptimizationCandidateExpand[]
Comma-separated list of expand keys. Pass mutations to populate mutation value fields; omit to receive mutation items containing only type. Additional expand keys may be added in future previews.
limit
integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
order
enum
Sort order by the candidate started_at timestamp.
after
string
Candidate-ID cursor identifying the last item from the previous page.
before
string
Candidate-ID cursor identifying the first item from the following page.
api-version
string
required
The API version to use for this operation.
Responses
The request has succeeded.
Body
data
AgentOptimizationCandidate[]
required
The requested list of items.
first_id
string
The first ID represented in this list.
last_id
string
The last ID represented in this list.
has_more
boolean
required
A value indicating whether there are additional values available not captured in this list.
Request
GET /agent_optimization_jobs/{jobId}/candidates HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json