Agent Control
Update an agent optimization result
Update status, activity, and AI request metadata fields on an agent optimization result.
Authorization
ApiKey read, writeAuthorization<token>
In: header
Scope: read, write
Path Parameters
projectKey*string
optimizationKey*string
resultId*string
Format
uuidRequest Body
application/json
Agent optimization result fields to update
status?AgentOptimizationResultStatus
Value in
- "RUNNING"
- "PASSED"
- "FAILED"
- "ERRORED"
activity?AgentOptimizationResultActivity
Value in
- "PENDING"
- "GENERATING"
- "EVALUATING"
- "GENERATING_VARIATION"
- "VALIDATING"
- "COMPLETED"
completionResponse?string
variation?
scores?
generationTokens?
evaluationTokens?
generationLatency?integer
evaluationLatencies?
createdVariationKey?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v2/projects/string/agent-optimizations/string/results/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "evaluationTokens": { "key": "" }, "generationTokens": { "key": "" }, "generationLatency": 0, "activity": "PENDING", "scores": { "key": "" }, "completionResponse": "completionResponse", "variation": { "key": "" }, "evaluationLatencies": { "key": "" }, "status": "RUNNING", "createdVariationKey": "createdVariationKey" }'{ "instructions": "instructions", "generationTokens": { "key": "" }, "completedAt": 5, "activity": "PENDING", "_links": { "parent": { "href": "href", "type": "type" }, "self": { "href": "href", "type": "type" } }, "scores": { "key": "" }, "variation": { "key": "" }, "evaluationLatencies": { "key": "" }, "createdVariationKey": "createdVariationKey", "evaluationTokens": { "key": "" }, "createdAt": 5, "agentOptimizationId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "generationLatency": 1, "_access": { "allowed": [ { "reason": { "role_name": "role_name", "notActions": [ null, null ], "notResources": [ "notResources", "notResources" ], "effect": "allow", "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "actions": [ "*" ] }, "action": "action" }, { "reason": { "role_name": "role_name", "notActions": [ null, null ], "notResources": [ "notResources", "notResources" ], "effect": "allow", "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "actions": [ "*" ] }, "action": "action" } ], "denied": [ { "reason": { "role_name": "role_name", "notActions": [ null, null ], "notResources": [ "notResources", "notResources" ], "effect": "allow", "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "actions": [ "*" ] }, "action": "action" }, { "reason": { "role_name": "role_name", "notActions": [ null, null ], "notResources": [ "notResources", "notResources" ], "effect": "allow", "resources": [ "proj/*:env/*;qa_*:/flag/*" ], "actions": [ "*" ] }, "action": "action" } ] }, "agentOptimizationVersion": 0, "completionResponse": "completionResponse", "iteration": 6, "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "runId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "userInput": "userInput", "parameters": { "key": "" }, "status": "RUNNING", "updatedAt": 2}