from chronicle import Chronicle
import os
world_id = os.environ["WORLD_ID"]
with Chronicle() as client:
result = client.worlds.retrieve(world_id)
print(result.world.id, result.status, result.evaluation)import { Chronicle } from "@chroniclelabs/sdk";
const client = new Chronicle();
const worldId = process.env.WORLD_ID;
if (!worldId) throw new Error("Set WORLD_ID");
const result = await client.worlds.retrieve(worldId);
console.log(result.world.id, result.status, result.evaluation);import { Chronicle } from "@chroniclelabs/sdk";
const client = new Chronicle();
const worldId = process.env.WORLD_ID;
if (!worldId) throw new Error("Set WORLD_ID");
const result = await client.worlds.retrieve(worldId);
console.log(result.world.id, result.status, result.evaluation);package main
import (
"context"
"fmt"
"log"
"os"
"time"
chronicle "github.com/chronicle-labs/chronicle-go"
)
func main() {
if err := example(); err != nil { log.Fatal(err) }
}
func example() error {
ctx, cancel := context.WithTimeout(context.Background(), 120*time.Second)
defer cancel()
client := chronicle.NewClient()
worldID := os.Getenv("WORLD_ID")
if worldID == "" { return fmt.Errorf("set WORLD_ID") }
result, err := client.Worlds.Retrieve(ctx, worldID)
if err != nil {
return err
}
fmt.Println(result.World.ID, result.Status, result.Evaluation)
return nil
}use chronicle_sdk::Chronicle;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Chronicle::from_env()?;
let world_id = std::env::var("WORLD_ID")?;
let result = client.worlds().retrieve(&world_id).await?;
println!("{} {:?} {:?}", result.world.id, result.status, result.evaluation);
Ok(())
}{
"status": "forging",
"twins": [
{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"id": "<string>",
"image": "<string>",
"service": "<string>",
"status": "running",
"tenantId": "<string>",
"token": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"datasetVersionId": "<string>",
"environmentVersionId": "<string>",
"error": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"flyAppName": "<string>",
"flyMachineId": "<string>",
"region": "<string>",
"scenarioId": "<string>"
}
],
"version": {
"number": 123,
"rootWorldId": "<string>",
"parentWorldId": "<string>"
},
"world": {
"blueprint": {
"clock": "<string>",
"identities": [
{
"department": "leadership",
"firstName": "<string>",
"handle": "<string>",
"lastName": "<string>",
"timezone": "<string>",
"title": "<string>",
"emailLocalPart": null,
"isApiOwner": false
}
],
"name": "<string>",
"organization": {
"description": "<string>",
"emailDomain": "<string>",
"industry": "<string>",
"name": "<string>",
"slug": "<string>",
"headquarters": null
},
"scenario": {
"narrative": "<string>",
"threads": [
{
"summary": "<string>",
"title": "<string>",
"touchpoints": [
{
"key": "<string>",
"role": "<string>",
"service": "slack"
}
]
}
],
"title": "<string>",
"suggestedTasks": [],
"tasks": []
},
"summary": "<string>",
"twins": {
"linear": null,
"salesforce": null,
"sapS4hana": null,
"slack": null
}
},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"id": "<string>",
"name": "<string>",
"summary": "<string>",
"tenantId": "<string>",
"twins": [
{
"entityCount": 123,
"seedSha256": "<string>",
"service": "<string>",
"twinInstanceId": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
},
"evaluation": {
"status": "materializing",
"version": 1,
"environmentId": "<string>",
"environmentVersionId": "<string>",
"error": "<string>",
"taskSuiteId": "<string>",
"taskSuiteVersionId": "<string>",
"tasks": []
},
"launchError": "<string>",
"warnings": []
}{
"error": "World not found"
}{
"error": "World not found"
}{
"error": "World not found"
}{
"error": "World not found"
}Get a saved world
One saved world version with its status, twins (URL, token, status), and task setup in evaluation.
Use the SDK setup with CHRONICLE_API_KEY and CHRONICLE_API_URL. The Go and Rust samples are complete entry points; Rust also needs Tokio (see Rust setup). Set WORLD_ID to the world.id returned by a launch or world-list result.
The schema below is the HTTP representation. SDKs normalize field names and list wrappers; see SDK and HTTP fields.
from chronicle import Chronicle
import os
world_id = os.environ["WORLD_ID"]
with Chronicle() as client:
result = client.worlds.retrieve(world_id)
print(result.world.id, result.status, result.evaluation)import { Chronicle } from "@chroniclelabs/sdk";
const client = new Chronicle();
const worldId = process.env.WORLD_ID;
if (!worldId) throw new Error("Set WORLD_ID");
const result = await client.worlds.retrieve(worldId);
console.log(result.world.id, result.status, result.evaluation);import { Chronicle } from "@chroniclelabs/sdk";
const client = new Chronicle();
const worldId = process.env.WORLD_ID;
if (!worldId) throw new Error("Set WORLD_ID");
const result = await client.worlds.retrieve(worldId);
console.log(result.world.id, result.status, result.evaluation);package main
import (
"context"
"fmt"
"log"
"os"
"time"
chronicle "github.com/chronicle-labs/chronicle-go"
)
func main() {
if err := example(); err != nil { log.Fatal(err) }
}
func example() error {
ctx, cancel := context.WithTimeout(context.Background(), 120*time.Second)
defer cancel()
client := chronicle.NewClient()
worldID := os.Getenv("WORLD_ID")
if worldID == "" { return fmt.Errorf("set WORLD_ID") }
result, err := client.Worlds.Retrieve(ctx, worldID)
if err != nil {
return err
}
fmt.Println(result.World.ID, result.Status, result.Evaluation)
return nil
}use chronicle_sdk::Chronicle;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Chronicle::from_env()?;
let world_id = std::env::var("WORLD_ID")?;
let result = client.worlds().retrieve(&world_id).await?;
println!("{} {:?} {:?}", result.world.id, result.status, result.evaluation);
Ok(())
}{
"status": "forging",
"twins": [
{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"id": "<string>",
"image": "<string>",
"service": "<string>",
"status": "running",
"tenantId": "<string>",
"token": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"baseUrl": "<string>",
"datasetVersionId": "<string>",
"environmentVersionId": "<string>",
"error": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"flyAppName": "<string>",
"flyMachineId": "<string>",
"region": "<string>",
"scenarioId": "<string>"
}
],
"version": {
"number": 123,
"rootWorldId": "<string>",
"parentWorldId": "<string>"
},
"world": {
"blueprint": {
"clock": "<string>",
"identities": [
{
"department": "leadership",
"firstName": "<string>",
"handle": "<string>",
"lastName": "<string>",
"timezone": "<string>",
"title": "<string>",
"emailLocalPart": null,
"isApiOwner": false
}
],
"name": "<string>",
"organization": {
"description": "<string>",
"emailDomain": "<string>",
"industry": "<string>",
"name": "<string>",
"slug": "<string>",
"headquarters": null
},
"scenario": {
"narrative": "<string>",
"threads": [
{
"summary": "<string>",
"title": "<string>",
"touchpoints": [
{
"key": "<string>",
"role": "<string>",
"service": "slack"
}
]
}
],
"title": "<string>",
"suggestedTasks": [],
"tasks": []
},
"summary": "<string>",
"twins": {
"linear": null,
"salesforce": null,
"sapS4hana": null,
"slack": null
}
},
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"id": "<string>",
"name": "<string>",
"summary": "<string>",
"tenantId": "<string>",
"twins": [
{
"entityCount": 123,
"seedSha256": "<string>",
"service": "<string>",
"twinInstanceId": "<string>"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
},
"evaluation": {
"status": "materializing",
"version": 1,
"environmentId": "<string>",
"environmentVersionId": "<string>",
"error": "<string>",
"taskSuiteId": "<string>",
"taskSuiteVersionId": "<string>",
"tasks": []
},
"launchError": "<string>",
"warnings": []
}{
"error": "World not found"
}{
"error": "World not found"
}{
"error": "World not found"
}{
"error": "World not found"
}Authorizations
Your Chronicle API key (chr_...). Create one in Settings > API keys.
Path Parameters
The world version ID, from world.id.
Response
Successful response.
A world with its twin instances resolved.
Aggregate of the world's twin instance statuses.
forging: At least one twin is still provisioning.
ready: Every twin is running.
degraded: Every twin is live but at least one failed its last health probe.
failed: At least one twin failed to provision.
retired: Every twin was stopped or expired.
forging, ready, degraded, failed, retired The live records of the twins in world.twins, same order.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A forged world as persisted: the blueprint plus the twins it spun up.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A launch failure is retained with its physical version for inspection.
Compiler warnings from the forge; only present on the forge response, never persisted.