Get a project agent's configuration snapshot
Derives the agent's AgentConfigurationV1 as GET /v1/agents/{agentId}/configuration-snapshot does, from a state a request recorded for this project carried: by default the agent's newest in this project, the one named by state_cid (404 agent_state_not_found unless a request in this project carried it), or with configuration_cid the newest state from one of the agent's active keys whose request in this project gave that configuration (404 configuration_not_observed, 409 configuration_not_running or configuration_changed, as on the global route). The observation is the newest whose signing key the gateway recorded, on it or on its exchange; when none of them names one the answer is 409 state_observation_unlinked, and the key must be one of the agent's active keys (409 state_signer_not_active_key). Giving both state_cid and configuration_cid is a 400, a state whose configuration can't be derived is a 422, and a derivation or lookup that may succeed on retry is a 503.
https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshotcurl --request GET \
--url 'https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot' \
--header 'Authorization: Bearer <token>'const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
const data = await response.json();interface ProjectAgentConfigurationSnapshotResponse {
agent_id?: string;
agent_key_dids?: string[];
agent_status?: string;
configuration?: Record<string, unknown>;
configuration_cid?: string;
correlation_id?: string;
data_scope?: Record<string, unknown>;
observation?: Record<string, unknown>;
}
const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: ProjectAgentConfigurationSnapshotResponse = await response.json();import requests
response = requests.get(
"https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot",
headers={
"Authorization": "Bearer <token>",
},
)
response.raise_for_status()
print(response.json())package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot"))
.header("Authorization", "Bearer <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$ch = curl_init('https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;require "net/http"
uri = URI("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"// Cargo.toml dependencies: reqwest, tokio (features "full")
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.get("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}/configuration-snapshot")
.header("Authorization", "Bearer <token>")
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and a sign-in token: a Guardian Platform JWT, or an OIDC ID token in a standalone deployment.ApiKeyAuth· API key in header "Authorization" — Type "Bearer" followed by a space and a Guardian Platform API key. Project-scoped routes and registration tokens check the key's scopes and project binding. Per-agent routes accept a key bound to no project that has empty scopes or full access, which acts as its holder, or a scope for what the route does: submit_agent_assessments reads an agent (its detail, configurations, state history and the files a state references, definitions, tools and operating profile, as its assessments rest on), view_agent_certifications reads its certifications, and manage_programs or review_agent_assessments attach a certification. A state's raw snapshot and findings, its audit exchanges and plugin events, and saving its operating profile take full access. A scope counts only while the key's holder still holds that permission in the key's organization, which auth-service reports as keyHeldScopes. A key never acts as an admin, so its holder's binding to the agent still decides.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
project_uuidrequired | string | Guardian project UUID |
agent_idrequired | string | Gateway agent ID or membership subject DID |
Query parameters
| Name | Type | Description |
|---|---|---|
state_cid | string | State CID from the agent's state history in this project |
configuration_cid | string | Configuration CID, bare or as a urn:cid, that one of the agent's states in this project gave |
Responses
200OK
agent_idstringagent_key_didsstring[]AgentKeyDIDs are the agent's active keys, so a consumer that pinned an earlier signer can tell a removed or revoked key from a changed configuration.
agent_statusstringconfigurationobjectconfiguration_cidstringcorrelation_idstringdata_scopegithub_com_eqtylab_gateway_control-plane_service_internal_discovery.ProjectDataScopeShow github_com_eqtylab_gateway_control-plane_service_internal_discovery.ProjectDataScope
authoritystringlegacy_records_excludedbooleanproject_urnstringscopestring
observationinternal_controlhttp.agentConfigurationObservationShow internal_controlhttp.agentConfigurationObservation
observed_atstringrequestagentconfig.RequestShow agentconfig.Request
modelstringproviderstringsystem_prompt_cidstringtoolsstring[]
signer_didstringstate_cidstringstate_correlation_idstringsub_agentstringSubAgent is the custom agent's sub-agent that made the observed request; it shares the agent's configuration.
viper_cidstringviper_versionstring
{
"agent_id": "string",
"agent_key_dids": [
"string"
],
"agent_status": "string",
"configuration": {},
"configuration_cid": "string",
"correlation_id": "string",
"data_scope": {
"authority": "string",
"legacy_records_excluded": true,
"project_urn": "string",
"scope": "string"
},
"observation": {
"observed_at": "string",
"request": {
"model": "string",
"provider": "string",
"system_prompt_cid": "string",
"tools": [
"string"
]
},
"signer_did": "string",
"state_cid": "string",
"state_correlation_id": "string",
"sub_agent": "string",
"viper_cid": "string",
"viper_version": "string"
}
}400Bad Request
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}401Unauthorized
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}403Forbidden
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}404Not Found
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}409Conflict
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}422Unprocessable Entity
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}500Internal Server Error
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}503Service Unavailable
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}