Get Version

GET

versions

{version_id}

Get Version

curl --request GET \
  --url https://api.example.com/versions/{version_id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/versions/{version_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/versions/{version_id}"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/versions/{version_id}")

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

request = Net::HTTP::Get.new(url)

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

{
  "author_email": "<string>",
  "author_name": "<string>",
  "branch_id": "<string>",
  "deployed_at": "2023-11-07T05:31:56Z",
  "git_branch": "<string>",
  "git_hash": "<string>",
  "id": "<string>",
  "image_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "failure_diagnostics": {},
  "failure_reason": "<string>",
  "git_message": "",
  "image_expires_at": "2023-11-07T05:31:56Z",
  "is_dirty": false,
  "last_rollback_at": "2023-11-07T05:31:56Z",
  "replicas": 0,
  "retired_at": "2023-11-07T05:31:56Z",
  "rollback_count": 0,
  "rolled_back_at": "2023-11-07T05:31:56Z",
  "source_filesystem_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

Path Parameters

version_id

string

required

Response

Successful Response

Full version details.

acp_type

enum<string>

required

Type of ACP server (sync or async)

Available options:

sync,

async

author_email

string

required

Commit author email

author_name

string

required

Commit author name

branch_id

string

required

Parent branch ID

deployed_at

string<date-time>

required

When this version was deployed

git_branch

string

required

Git branch name

git_hash

string

required

Git commit hash

string

required

Version ID

image_url

string

required

Container image URL

sdk_type

enum<string>

required

SDK type for agent runtime

Available options:

claude_agent_sdk,

codex_agent_sdk

status

enum<string>

required

Version lifecycle status

Available options:

DEPLOYING,

ACTIVE,

FAILED,

UNHEALTHY,

DRAINING,

RETIRED,

ROLLED_BACK

created_at

string<date-time> | null

Creation timestamp

failure_diagnostics

Failure Diagnostics · object | null

User-facing failure diagnostics with 'title', 'description', and 'action' fields

Show child attributes

failure_reason

string | null

Classified failure reason when status is FAILED (e.g., 'image_pull_failed', 'crash_loop', 'scheduling_failed')

git_message

string

default:""

Git commit message

image_expires_at

string<date-time> | null

When image expires (for rollback window)

is_dirty

boolean

default:false

Whether the commit had uncommitted changes

last_rollback_at

string<date-time> | null

Timestamp when this version was last rolled back TO

replicas

integer

default:0

Current pod count for this version

retired_at

string<date-time> | null

When version was retired

rollback_count

integer

default:0

Number of rollbacks to this version

rolled_back_at

string<date-time> | null

Timestamp when this version was rolled back FROM

source_filesystem_id

string | null

Filesystem snapshot that can reopen this version in Agent Builder

updated_at

string<date-time> | null

Last update timestamp

List TasksList all tasks.

Get Version

curl --request GET \
  --url https://api.example.com/versions/{version_id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/versions/{version_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/versions/{version_id}"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/versions/{version_id}")

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

request = Net::HTTP::Get.new(url)

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

{
  "author_email": "<string>",
  "author_name": "<string>",
  "branch_id": "<string>",
  "deployed_at": "2023-11-07T05:31:56Z",
  "git_branch": "<string>",
  "git_hash": "<string>",
  "id": "<string>",
  "image_url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "failure_diagnostics": {},
  "failure_reason": "<string>",
  "git_message": "",
  "image_expires_at": "2023-11-07T05:31:56Z",
  "is_dirty": false,
  "last_rollback_at": "2023-11-07T05:31:56Z",
  "replicas": 0,
  "retired_at": "2023-11-07T05:31:56Z",
  "rollback_count": 0,
  "rolled_back_at": "2023-11-07T05:31:56Z",
  "source_filesystem_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

Get Started

Core Concepts

Build Agents

Deploy & Operate

Security & Access

API

Path Parameters

Response