Run Agent
post/run
Request body
appNamestring nullable
userIdstring required
sessionIdstring required
streamingboolean
stateDeltaobject nullable
functionCallEventIdstring nullable
invocationIdstring nullable
customMetadataobject nullable
Response
Successful Response
modelVersionstring nullable
partialboolean nullable
turnCompleteboolean nullable
turnCompleteReason'TURN_COMPLETE_REASON_UNSPECIFIED' | 'MALFORMED_FUNCTION_CALL' | 'RESPONSE_REJECTED' | 'NEED_MORE_INPUT' | 'PROHIBITED_INPUT_CONTENT' | 'IMAGE_PROHIBITED_INPUT_CONTENT' | 'INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED' | 'INPUT_IMAGE_CELEBRITY' | 'INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED' | 'INPUT_TEXT_NCII_PROHIBITED' | 'INPUT_OTHER' | 'INPUT_IP_PROHIBITED' | 'BLOCKLIST' | 'UNSAFE_PROMPT_FOR_IMAGE_GENERATION' | 'GENERATED_IMAGE_SAFETY' | 'GENERATED_CONTENT_SAFETY' | 'GENERATED_AUDIO_SAFETY' | 'GENERATED_VIDEO_SAFETY' | 'GENERATED_CONTENT_PROHIBITED' | 'GENERATED_CONTENT_BLOCKLIST' | 'GENERATED_IMAGE_PROHIBITED' | 'GENERATED_IMAGE_CELEBRITY' | 'GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER' | 'GENERATED_IMAGE_IDENTIFIABLE_PEOPLE' | 'GENERATED_IMAGE_MINORS' | 'OUTPUT_IMAGE_IP_PROHIBITED' | 'GENERATED_OTHER' | 'MAX_REGENERATION_REACHED'
The reason why the turn is complete.
finishReason'FINISH_REASON_UNSPECIFIED' | 'STOP' | 'MAX_TOKENS' | 'SAFETY' | 'RECITATION' | 'LANGUAGE' | 'OTHER' | 'BLOCKLIST' | 'PROHIBITED_CONTENT' | 'SPII' | 'MALFORMED_FUNCTION_CALL' | 'IMAGE_SAFETY' | 'UNEXPECTED_TOOL_CALL' | 'IMAGE_PROHIBITED_CONTENT' | 'NO_IMAGE' | 'IMAGE_RECITATION' | 'IMAGE_OTHER'
Output only. The reason why the model stopped generating tokens.
If empty, the model has not stopped generating the tokens.
errorCodestring nullable
errorMessagestring nullable
interruptedboolean nullable
customMetadataobject nullable
liveSessionIdstring nullable
avgLogprobsnumber nullable
interactionIdstring nullable
environmentIdstring nullable
invocationIdstring
authorstring
{"stackTrail":"components:schemas:Event-Output:properties:output:anyOf","oasType":"schema","type":"unknown","title":"Output","nullable":true}
longRunningToolIdsstring[] nullable
branchstring nullable
isolationScopestring nullable
idstring
timestampnumber