Run an agent

curl --request POST \
  --url http://localhost:8000/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "user-001",
  "sessionId": "session-001"
}
'

import requests

url = "http://localhost:8000/run"

payload = {
    "userId": "user-001",
    "sessionId": "session-001"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({userId: 'user-001', sessionId: 'session-001'})
};

fetch('http://localhost:8000/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "modelVersion": "<string>",
    "content": {
      "parts": [
        {
          "mediaResolution": {
            "level": "MEDIA_RESOLUTION_UNSPECIFIED",
            "numTokens": 123
          },
          "codeExecutionResult": {
            "outcome": "OUTCOME_UNSPECIFIED",
            "output": "<string>",
            "id": "<string>"
          },
          "executableCode": {
            "code": "<string>",
            "language": "LANGUAGE_UNSPECIFIED",
            "id": "<string>"
          },
          "fileData": {
            "displayName": "<string>",
            "fileUri": "<string>",
            "mimeType": "<string>"
          },
          "functionCall": {
            "id": "<string>",
            "args": {},
            "name": "<string>",
            "partialArgs": [
              {
                "boolValue": true,
                "jsonPath": "<string>",
                "nullValue": "NULL_VALUE",
                "numberValue": 123,
                "stringValue": "<string>",
                "willContinue": true
              }
            ],
            "willContinue": true
          },
          "functionResponse": {
            "willContinue": true,
            "scheduling": "SCHEDULING_UNSPECIFIED",
            "parts": [
              {
                "inlineData": {
                  "mimeType": "<string>",
                  "data": "<string>",
                  "displayName": "<string>"
                },
                "fileData": {
                  "fileUri": "<string>",
                  "mimeType": "<string>",
                  "displayName": "<string>"
                }
              }
            ],
            "id": "<string>",
            "name": "<string>",
            "response": {}
          },
          "inlineData": {
            "data": "<string>",
            "displayName": "<string>",
            "mimeType": "<string>"
          },
          "text": "<string>",
          "thought": true,
          "thoughtSignature": "<string>",
          "videoMetadata": {
            "endOffset": "<string>",
            "fps": 123,
            "startOffset": "<string>"
          },
          "toolCall": {
            "id": "<string>",
            "toolType": "TOOL_TYPE_UNSPECIFIED",
            "args": {}
          },
          "toolResponse": {
            "id": "<string>",
            "toolType": "TOOL_TYPE_UNSPECIFIED",
            "response": {}
          },
          "partMetadata": {}
        }
      ],
      "role": "<string>"
    },
    "groundingMetadata": {
      "imageSearchQueries": [
        "<string>"
      ],
      "groundingChunks": [
        {
          "image": {
            "sourceUri": "<string>",
            "imageUri": "<string>",
            "title": "<string>",
            "domain": "<string>"
          },
          "maps": {
            "placeAnswerSources": {
              "reviewSnippet": [
                {
                  "authorAttribution": {
                    "displayName": "<string>",
                    "photoUri": "<string>",
                    "uri": "<string>"
                  },
                  "flagContentUri": "<string>",
                  "googleMapsUri": "<string>",
                  "relativePublishTimeDescription": "<string>",
                  "review": "<string>",
                  "reviewId": "<string>",
                  "title": "<string>"
                }
              ],
              "flagContentUri": "<string>",
              "reviewSnippets": [
                {
                  "authorAttribution": {
                    "displayName": "<string>",
                    "photoUri": "<string>",
                    "uri": "<string>"
                  },
                  "flagContentUri": "<string>",
                  "googleMapsUri": "<string>",
                  "relativePublishTimeDescription": "<string>",
                  "review": "<string>",
                  "reviewId": "<string>",
                  "title": "<string>"
                }
              ]
            },
            "placeId": "<string>",
            "text": "<string>",
            "title": "<string>",
            "uri": "<string>",
            "route": {
              "distanceMeters": 123,
              "duration": "<string>",
              "encodedPolyline": "<string>"
            }
          },
          "retrievedContext": {
            "documentName": "<string>",
            "ragChunk": {
              "pageSpan": {
                "firstPage": 123,
                "lastPage": 123
              },
              "text": "<string>",
              "chunkId": "<string>",
              "fileId": "<string>"
            },
            "text": "<string>",
            "title": "<string>",
            "uri": "<string>",
            "customMetadata": [
              {
                "key": "<string>",
                "numericValue": 123,
                "stringListValue": {
                  "values": [
                    "<string>"
                  ]
                },
                "stringValue": "<string>"
              }
            ],
            "fileSearchStore": "<string>",
            "pageNumber": 123,
            "mediaId": "<string>"
          },
          "web": {
            "domain": "<string>",
            "title": "<string>",
            "uri": "<string>"
          }
        }
      ],
      "groundingSupports": [
        {
          "confidenceScores": [
            123
          ],
          "groundingChunkIndices": [
            123
          ],
          "segment": {
            "startIndex": 123,
            "endIndex": 123,
            "partIndex": 123,
            "text": "<string>"
          },
          "renderedParts": [
            123
          ]
        }
      ],
      "retrievalMetadata": {
        "googleSearchDynamicRetrievalScore": 123
      },
      "searchEntryPoint": {
        "renderedContent": "<string>",
        "sdkBlob": "<string>"
      },
      "webSearchQueries": [
        "<string>"
      ],
      "googleMapsWidgetContextToken": "<string>",
      "retrievalQueries": [
        "<string>"
      ],
      "sourceFlaggingUris": [
        {
          "flagContentUri": "<string>",
          "sourceId": "<string>"
        }
      ]
    },
    "partial": true,
    "turnComplete": true,
    "turnCompleteReason": "TURN_COMPLETE_REASON_UNSPECIFIED",
    "finishReason": "FINISH_REASON_UNSPECIFIED",
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "interrupted": true,
    "customMetadata": {},
    "usageMetadata": {
      "cacheTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "cachedContentTokenCount": 123,
      "candidatesTokenCount": 123,
      "candidatesTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "promptTokenCount": 123,
      "promptTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "thoughtsTokenCount": 123,
      "toolUsePromptTokenCount": 123,
      "toolUsePromptTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "totalTokenCount": 123,
      "trafficType": "TRAFFIC_TYPE_UNSPECIFIED"
    },
    "liveSessionResumptionUpdate": {
      "newHandle": "<string>",
      "resumable": true,
      "lastConsumedClientMessageIndex": 123
    },
    "liveSessionId": "<string>",
    "goAway": {
      "timeLeft": "<string>"
    },
    "inputTranscription": {
      "text": "<string>",
      "finished": true,
      "languageCode": "<string>"
    },
    "outputTranscription": {
      "text": "<string>",
      "finished": true,
      "languageCode": "<string>"
    },
    "avgLogprobs": 123,
    "logprobsResult": {
      "chosenCandidates": [
        {
          "logProbability": 123,
          "token": "<string>",
          "tokenId": 123
        }
      ],
      "topCandidates": [
        {
          "candidates": [
            {
              "logProbability": 123,
              "token": "<string>",
              "tokenId": 123
            }
          ]
        }
      ],
      "logProbabilitySum": 123
    },
    "cacheMetadata": {
      "fingerprint": "<string>",
      "contents_count": 1,
      "cache_name": "<string>",
      "expire_time": 123,
      "invocations_used": 1,
      "created_at": 123
    },
    "citationMetadata": {
      "citations": [
        {
          "endIndex": 123,
          "license": "<string>",
          "publicationDate": {
            "day": 123,
            "month": 123,
            "year": 123
          },
          "startIndex": 123,
          "title": "<string>",
          "uri": "<string>"
        }
      ]
    },
    "interactionId": "<string>",
    "invocationId": "",
    "author": "",
    "actions": {
      "skipSummarization": true,
      "stateDelta": {},
      "artifactDelta": {},
      "transferToAgent": "<string>",
      "escalate": true,
      "requestedAuthConfigs": {},
      "requestedToolConfirmations": {},
      "compaction": {
        "startTimestamp": 123,
        "endTimestamp": 123,
        "compactedContent": {
          "parts": [
            {
              "mediaResolution": {
                "level": "MEDIA_RESOLUTION_UNSPECIFIED",
                "numTokens": 123
              },
              "codeExecutionResult": {
                "outcome": "OUTCOME_UNSPECIFIED",
                "output": "<string>",
                "id": "<string>"
              },
              "executableCode": {
                "code": "<string>",
                "language": "LANGUAGE_UNSPECIFIED",
                "id": "<string>"
              },
              "fileData": {
                "displayName": "<string>",
                "fileUri": "<string>",
                "mimeType": "<string>"
              },
              "functionCall": {
                "id": "<string>",
                "args": {},
                "name": "<string>",
                "partialArgs": [
                  {
                    "boolValue": true,
                    "jsonPath": "<string>",
                    "nullValue": "NULL_VALUE",
                    "numberValue": 123,
                    "stringValue": "<string>",
                    "willContinue": true
                  }
                ],
                "willContinue": true
              },
              "functionResponse": {
                "willContinue": true,
                "scheduling": "SCHEDULING_UNSPECIFIED",
                "parts": [
                  {
                    "inlineData": {
                      "mimeType": "<string>",
                      "data": "<string>",
                      "displayName": "<string>"
                    },
                    "fileData": {
                      "fileUri": "<string>",
                      "mimeType": "<string>",
                      "displayName": "<string>"
                    }
                  }
                ],
                "id": "<string>",
                "name": "<string>",
                "response": {}
              },
              "inlineData": {
                "data": "<string>",
                "displayName": "<string>",
                "mimeType": "<string>"
              },
              "text": "<string>",
              "thought": true,
              "thoughtSignature": "<string>",
              "videoMetadata": {
                "endOffset": "<string>",
                "fps": 123,
                "startOffset": "<string>"
              },
              "toolCall": {
                "id": "<string>",
                "toolType": "TOOL_TYPE_UNSPECIFIED",
                "args": {}
              },
              "toolResponse": {
                "id": "<string>",
                "toolType": "TOOL_TYPE_UNSPECIFIED",
                "response": {}
              },
              "partMetadata": {}
            }
          ],
          "role": "<string>"
        }
      },
      "endOfAgent": true,
      "agentState": {},
      "rewindBeforeInvocationId": "<string>",
      "route": true,
      "renderUiWidgets": [
        {
          "id": "<string>",
          "provider": "<string>",
          "payload": {}
        }
      ],
      "setModelResponse": null
    },
    "output": null,
    "nodeInfo": {
      "path": "",
      "outputFor": [
        "<string>"
      ],
      "messageAsOutput": true
    },
    "longRunningToolIds": [
      "<string>"
    ],
    "branch": "<string>",
    "isolationScope": "<string>",
    "id": "",
    "timestamp": 123
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

run

Run an agent

curl --request POST \
  --url http://localhost:8000/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "user-001",
  "sessionId": "session-001"
}
'

import requests

url = "http://localhost:8000/run"

payload = {
    "userId": "user-001",
    "sessionId": "session-001"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({userId: 'user-001', sessionId: 'session-001'})
};

fetch('http://localhost:8000/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "modelVersion": "<string>",
    "content": {
      "parts": [
        {
          "mediaResolution": {
            "level": "MEDIA_RESOLUTION_UNSPECIFIED",
            "numTokens": 123
          },
          "codeExecutionResult": {
            "outcome": "OUTCOME_UNSPECIFIED",
            "output": "<string>",
            "id": "<string>"
          },
          "executableCode": {
            "code": "<string>",
            "language": "LANGUAGE_UNSPECIFIED",
            "id": "<string>"
          },
          "fileData": {
            "displayName": "<string>",
            "fileUri": "<string>",
            "mimeType": "<string>"
          },
          "functionCall": {
            "id": "<string>",
            "args": {},
            "name": "<string>",
            "partialArgs": [
              {
                "boolValue": true,
                "jsonPath": "<string>",
                "nullValue": "NULL_VALUE",
                "numberValue": 123,
                "stringValue": "<string>",
                "willContinue": true
              }
            ],
            "willContinue": true
          },
          "functionResponse": {
            "willContinue": true,
            "scheduling": "SCHEDULING_UNSPECIFIED",
            "parts": [
              {
                "inlineData": {
                  "mimeType": "<string>",
                  "data": "<string>",
                  "displayName": "<string>"
                },
                "fileData": {
                  "fileUri": "<string>",
                  "mimeType": "<string>",
                  "displayName": "<string>"
                }
              }
            ],
            "id": "<string>",
            "name": "<string>",
            "response": {}
          },
          "inlineData": {
            "data": "<string>",
            "displayName": "<string>",
            "mimeType": "<string>"
          },
          "text": "<string>",
          "thought": true,
          "thoughtSignature": "<string>",
          "videoMetadata": {
            "endOffset": "<string>",
            "fps": 123,
            "startOffset": "<string>"
          },
          "toolCall": {
            "id": "<string>",
            "toolType": "TOOL_TYPE_UNSPECIFIED",
            "args": {}
          },
          "toolResponse": {
            "id": "<string>",
            "toolType": "TOOL_TYPE_UNSPECIFIED",
            "response": {}
          },
          "partMetadata": {}
        }
      ],
      "role": "<string>"
    },
    "groundingMetadata": {
      "imageSearchQueries": [
        "<string>"
      ],
      "groundingChunks": [
        {
          "image": {
            "sourceUri": "<string>",
            "imageUri": "<string>",
            "title": "<string>",
            "domain": "<string>"
          },
          "maps": {
            "placeAnswerSources": {
              "reviewSnippet": [
                {
                  "authorAttribution": {
                    "displayName": "<string>",
                    "photoUri": "<string>",
                    "uri": "<string>"
                  },
                  "flagContentUri": "<string>",
                  "googleMapsUri": "<string>",
                  "relativePublishTimeDescription": "<string>",
                  "review": "<string>",
                  "reviewId": "<string>",
                  "title": "<string>"
                }
              ],
              "flagContentUri": "<string>",
              "reviewSnippets": [
                {
                  "authorAttribution": {
                    "displayName": "<string>",
                    "photoUri": "<string>",
                    "uri": "<string>"
                  },
                  "flagContentUri": "<string>",
                  "googleMapsUri": "<string>",
                  "relativePublishTimeDescription": "<string>",
                  "review": "<string>",
                  "reviewId": "<string>",
                  "title": "<string>"
                }
              ]
            },
            "placeId": "<string>",
            "text": "<string>",
            "title": "<string>",
            "uri": "<string>",
            "route": {
              "distanceMeters": 123,
              "duration": "<string>",
              "encodedPolyline": "<string>"
            }
          },
          "retrievedContext": {
            "documentName": "<string>",
            "ragChunk": {
              "pageSpan": {
                "firstPage": 123,
                "lastPage": 123
              },
              "text": "<string>",
              "chunkId": "<string>",
              "fileId": "<string>"
            },
            "text": "<string>",
            "title": "<string>",
            "uri": "<string>",
            "customMetadata": [
              {
                "key": "<string>",
                "numericValue": 123,
                "stringListValue": {
                  "values": [
                    "<string>"
                  ]
                },
                "stringValue": "<string>"
              }
            ],
            "fileSearchStore": "<string>",
            "pageNumber": 123,
            "mediaId": "<string>"
          },
          "web": {
            "domain": "<string>",
            "title": "<string>",
            "uri": "<string>"
          }
        }
      ],
      "groundingSupports": [
        {
          "confidenceScores": [
            123
          ],
          "groundingChunkIndices": [
            123
          ],
          "segment": {
            "startIndex": 123,
            "endIndex": 123,
            "partIndex": 123,
            "text": "<string>"
          },
          "renderedParts": [
            123
          ]
        }
      ],
      "retrievalMetadata": {
        "googleSearchDynamicRetrievalScore": 123
      },
      "searchEntryPoint": {
        "renderedContent": "<string>",
        "sdkBlob": "<string>"
      },
      "webSearchQueries": [
        "<string>"
      ],
      "googleMapsWidgetContextToken": "<string>",
      "retrievalQueries": [
        "<string>"
      ],
      "sourceFlaggingUris": [
        {
          "flagContentUri": "<string>",
          "sourceId": "<string>"
        }
      ]
    },
    "partial": true,
    "turnComplete": true,
    "turnCompleteReason": "TURN_COMPLETE_REASON_UNSPECIFIED",
    "finishReason": "FINISH_REASON_UNSPECIFIED",
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "interrupted": true,
    "customMetadata": {},
    "usageMetadata": {
      "cacheTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "cachedContentTokenCount": 123,
      "candidatesTokenCount": 123,
      "candidatesTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "promptTokenCount": 123,
      "promptTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "thoughtsTokenCount": 123,
      "toolUsePromptTokenCount": 123,
      "toolUsePromptTokensDetails": [
        {
          "modality": "MODALITY_UNSPECIFIED",
          "tokenCount": 123
        }
      ],
      "totalTokenCount": 123,
      "trafficType": "TRAFFIC_TYPE_UNSPECIFIED"
    },
    "liveSessionResumptionUpdate": {
      "newHandle": "<string>",
      "resumable": true,
      "lastConsumedClientMessageIndex": 123
    },
    "liveSessionId": "<string>",
    "goAway": {
      "timeLeft": "<string>"
    },
    "inputTranscription": {
      "text": "<string>",
      "finished": true,
      "languageCode": "<string>"
    },
    "outputTranscription": {
      "text": "<string>",
      "finished": true,
      "languageCode": "<string>"
    },
    "avgLogprobs": 123,
    "logprobsResult": {
      "chosenCandidates": [
        {
          "logProbability": 123,
          "token": "<string>",
          "tokenId": 123
        }
      ],
      "topCandidates": [
        {
          "candidates": [
            {
              "logProbability": 123,
              "token": "<string>",
              "tokenId": 123
            }
          ]
        }
      ],
      "logProbabilitySum": 123
    },
    "cacheMetadata": {
      "fingerprint": "<string>",
      "contents_count": 1,
      "cache_name": "<string>",
      "expire_time": 123,
      "invocations_used": 1,
      "created_at": 123
    },
    "citationMetadata": {
      "citations": [
        {
          "endIndex": 123,
          "license": "<string>",
          "publicationDate": {
            "day": 123,
            "month": 123,
            "year": 123
          },
          "startIndex": 123,
          "title": "<string>",
          "uri": "<string>"
        }
      ]
    },
    "interactionId": "<string>",
    "invocationId": "",
    "author": "",
    "actions": {
      "skipSummarization": true,
      "stateDelta": {},
      "artifactDelta": {},
      "transferToAgent": "<string>",
      "escalate": true,
      "requestedAuthConfigs": {},
      "requestedToolConfirmations": {},
      "compaction": {
        "startTimestamp": 123,
        "endTimestamp": 123,
        "compactedContent": {
          "parts": [
            {
              "mediaResolution": {
                "level": "MEDIA_RESOLUTION_UNSPECIFIED",
                "numTokens": 123
              },
              "codeExecutionResult": {
                "outcome": "OUTCOME_UNSPECIFIED",
                "output": "<string>",
                "id": "<string>"
              },
              "executableCode": {
                "code": "<string>",
                "language": "LANGUAGE_UNSPECIFIED",
                "id": "<string>"
              },
              "fileData": {
                "displayName": "<string>",
                "fileUri": "<string>",
                "mimeType": "<string>"
              },
              "functionCall": {
                "id": "<string>",
                "args": {},
                "name": "<string>",
                "partialArgs": [
                  {
                    "boolValue": true,
                    "jsonPath": "<string>",
                    "nullValue": "NULL_VALUE",
                    "numberValue": 123,
                    "stringValue": "<string>",
                    "willContinue": true
                  }
                ],
                "willContinue": true
              },
              "functionResponse": {
                "willContinue": true,
                "scheduling": "SCHEDULING_UNSPECIFIED",
                "parts": [
                  {
                    "inlineData": {
                      "mimeType": "<string>",
                      "data": "<string>",
                      "displayName": "<string>"
                    },
                    "fileData": {
                      "fileUri": "<string>",
                      "mimeType": "<string>",
                      "displayName": "<string>"
                    }
                  }
                ],
                "id": "<string>",
                "name": "<string>",
                "response": {}
              },
              "inlineData": {
                "data": "<string>",
                "displayName": "<string>",
                "mimeType": "<string>"
              },
              "text": "<string>",
              "thought": true,
              "thoughtSignature": "<string>",
              "videoMetadata": {
                "endOffset": "<string>",
                "fps": 123,
                "startOffset": "<string>"
              },
              "toolCall": {
                "id": "<string>",
                "toolType": "TOOL_TYPE_UNSPECIFIED",
                "args": {}
              },
              "toolResponse": {
                "id": "<string>",
                "toolType": "TOOL_TYPE_UNSPECIFIED",
                "response": {}
              },
              "partMetadata": {}
            }
          ],
          "role": "<string>"
        }
      },
      "endOfAgent": true,
      "agentState": {},
      "rewindBeforeInvocationId": "<string>",
      "route": true,
      "renderUiWidgets": [
        {
          "id": "<string>",
          "provider": "<string>",
          "payload": {}
        }
      ],
      "setModelResponse": null
    },
    "output": null,
    "nodeInfo": {
      "path": "",
      "outputFor": [
        "<string>"
      ],
      "messageAsOutput": true
    },
    "longRunningToolIds": [
      "<string>"
    ],
    "branch": "<string>",
    "isolationScope": "<string>",
    "id": "",
    "timestamp": 123
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Submit one turn and receive the complete event array after execution. Create a session first by default, and use its application, user, and session identifiers consistently

Execution writes session events and can call models, tools, and external resources. Retrying the same request can repeat those actions; confirm the target before sending it

This endpoint always returns a JSON array; streaming: true does not change it to SSE. Use Run an agent with SSE to consume events as they arrive

Body

application/json

userId

string

required

User ID

sessionId

string

required

Session ID

appName

string | null

Application name; falls back to ADK_DEFAULT_APP_NAME when omitted and returns 400 if no default is configured

newMessage

Content · object | null

Input message for this turn; it may be omitted when resuming an invocation supported by the application

Show child attributes

streaming

boolean

default:false

Request incremental model streaming; defaults to false

stateDelta

Statedelta · object | null

Session state changes to apply

functionCallEventId

string | null

Event ID of the function call, used for streaming function-response handling

invocationId

string | null

Invocation ID

customMetadata

Custommetadata · object | null

Custom metadata

Response

Successful response

modelVersion

string | null

Model version

content

Content · object | null

Message content

Show child attributes

groundingMetadata

GroundingMetadata · object | null

Show child attributes

partial

boolean | null

Whether this event contains partial content

turnComplete

boolean | null

Whether the current turn is complete

turnCompleteReason

enum<string> | null

Available options:

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

finishReason

enum<string> | null

Reason generation ended

Available options:

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

errorCode

string | null

Error code

errorMessage

string | null

Error message

interrupted

boolean | null

Whether the response was interrupted

customMetadata

Custommetadata · object | null

Custom metadata

usageMetadata

GenerateContentResponseUsageMetadata · object | null

Model usage information

Show child attributes

liveSessionResumptionUpdate

LiveServerSessionResumptionUpdate · object | null

Show child attributes

liveSessionId

string | null

goAway

LiveServerGoAway · object | null

Show child attributes

inputTranscription

Transcription · object | null

Show child attributes

outputTranscription

Transcription · object | null

Show child attributes

avgLogprobs

number | null

logprobsResult

LogprobsResult · object | null

Show child attributes

cacheMetadata

CacheMetadata · object | null

Show child attributes

citationMetadata

CitationMetadata · object | null

Show child attributes

interactionId

string | null

Interaction ID

invocationId

string

default:""

Invocation ID

author

string

default:""

Event author, usually user or an agent name

actions

EventActions · object

State, artifact, and control actions carried by the event

Show child attributes

output

unknown

nodeInfo

NodeInfo · object

Show child attributes

longRunningToolIds

string[] | null

IDs of long-running tool calls awaiting results

branch

string | null

Execution branch associated with the event

isolationScope

string | null

string

default:""

Identifier

timestamp

number

Event time as a Unix timestamp in seconds

Last modified on September 19, 2026

Agent API Server API

Harness Runtime API

Run an agent

Body

Response