Get Team Run

Retrieve the status and output of a team run. Use this to poll for background run completion.

Requires the session_id that was returned when the run was created.

GET /teams/{team_id}/runs/{run_id}

Get Team Run

cURL

curl --request GET \
  --url https://api.example.com/teams/{team_id}/runs/{run_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/teams/{team_id}/runs/{run_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/teams/{team_id}/runs/{run_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/teams/{team_id}/runs/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/teams/{team_id}/runs/{run_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/teams/{team_id}/runs/{run_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/teams/{team_id}/runs/{run_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "run_id": "<string>",
  "parent_run_id": "<string>",
  "team_id": "<string>",
  "status": "<string>",
  "content": "<string>",
  "reasoning_content": "<string>",
  "reasoning_steps": [
    {}
  ],
  "run_input": "<string>",
  "run_response_format": "<string>",
  "metrics": {},
  "tools": [
    {}
  ],
  "messages": [
    {}
  ],
  "events": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "references": [
    {}
  ],
  "citations": {},
  "reasoning_messages": [
    {}
  ],
  "session_state": {},
  "input_media": {},
  "images": [
    {}
  ],
  "videos": [
    {}
  ],
  "audio": [
    {}
  ],
  "files": [
    {}
  ],
  "response_audio": {},
  "followups": [
    "<string>"
  ],
  "forked_from_run_id": "<string>",
  "forked_from_message_index": 123,
  "forked_from_session_id": "<string>",
  "regenerated_from": "<string>",
  "last_checkpoint_at_message_index": 123
}

{
  "detail": "Bad request",
  "error_code": "BAD_REQUEST"
}

{
  "detail": "Unauthenticated access",
  "error_code": "UNAUTHENTICATED"
}

{
  "detail": "Insufficient permissions"
}

{
  "detail": "Not found",
  "error_code": "NOT_FOUND"
}

{
  "detail": "Validation error",
  "error_code": "VALIDATION_ERROR"
}

{
  "detail": "Internal server error",
  "error_code": "INTERNAL_SERVER_ERROR"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id · string · required

run_id · string · required

Query Parameters

session_id · string · required

Session ID for the run

Response

200

application/json

Run output retrieved successfully

run_id · string · required

Unique identifier for the team run

parent_run_id · string | null

Parent run ID if this is a nested run

team_id · string | null

Team ID that executed this run

status · string | null

Run status (PENDING, RUNNING, COMPLETED, ERROR, etc.)

content · string Content · object

Output content from the team run

reasoning_content · string | null

Reasoning content if reasoning was enabled

reasoning_steps · Reasoning Steps · object[] | null

List of reasoning steps

run_input · string | null

Input provided to the run

run_response_format · string | null

Format of the response (text/json)

metrics · Metrics · object | null

Performance and usage metrics

tools · Tools · object[] | null

Tools used in the run

messages · Messages · object[] | null

Message history for the run

events · Events · object[] | null

Events generated during the run

created_at · string<date-time> | null

Run creation timestamp

references · References · object[] | null

References cited in the run

citations · Citations · object | null

Citations from the model (e.g., from Gemini grounding/search)

reasoning_messages · Reasoning Messages · object[] | null

Reasoning process messages

session_state · Session State · object | null

Session state at the end of the run

input_media · Input Media · object | null

Input media attachments

images · Images · object[] | null

Images included in the run

videos · Videos · object[] | null

Videos included in the run

audio · Audio · object[] | null

Audio files included in the run

files · Files · object[] | null

Files included in the run

response_audio · Response Audio · object | null

Audio response if generated

followups · string[] | null

Followup suggestions generated after the run

forked_from_run_id · string | null

If this team run was forked from another run, the source run's ID

forked_from_message_index · integer | null

If this team run was forked, the message index at which the source was truncated

forked_from_session_id · string | null

If this team run was created via session branch, the source session's ID

regenerated_from · string | null

If this team run was produced via regenerate=true, the source run's ID

last_checkpoint_at_message_index · integer | null

Message index of the most recent mid-run checkpoint (checkpoint='tool-batch' runs)