Get an objective

JavaScript

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const objective = await client.objectives.retrieve('obj_01HXKD2E5NQM3T9AYWCFQAZGFV', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(objective.configSnapshot);

import os
from cadenya import Cadenya

client = Cadenya(
    api_key=os.environ.get("CADENYA_API_KEY"),  # This is the default and can be omitted
)
objective = client.objectives.retrieve(
    id="obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(objective.config_snapshot)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	objective, err := client.Objectives.Get(
		context.TODO(),
		"obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
		cadenya.ObjectiveGetParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", objective.ConfigSnapshot)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

objective = cadenya.objectives.retrieve(
  "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(objective)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/objectives/{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;
}

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "createdAt": "2023-11-07T05:31:56Z",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "labels": {},
    "externalId": "<string>"
  },
  "configSnapshot": {
    "agent": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "description": "<string>",
        "webhookEventsUrl": "<string>",
        "systemPromptDataSchema": {},
        "outputDefinition": {},
        "enableEpisodicMemory": true,
        "episodicMemoryTtl": 123
      },
      "info": {
        "variationCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        }
      }
    },
    "agentVariation": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "systemPromptTemplate": "<string>",
        "progressiveDiscovery": {
          "maxTools": 123,
          "hints": [
            "<string>"
          ]
        },
        "constraints": {
          "maxToolCalls": 123,
          "maxSubObjectives": 123,
          "inactivityTimeout": "<string>"
        },
        "description": "<string>",
        "modelConfig": {
          "modelId": "claude/opus-4.6",
          "temperature": 123
        },
        "compactionConfig": {
          "triggerThreshold": 123,
          "summarization": {
            "instructions": "<string>"
          },
          "toolResultClearing": {
            "preserveRecentResults": 123
          }
        },
        "firstUserMessageTemplate": "<string>"
      },
      "info": {
        "toolCount": 123,
        "toolSetCount": 123,
        "subAgentCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        },
        "model": {
          "id": "<string>",
          "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
          "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
          "name": "<string>",
          "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
          "createdAt": "2023-11-07T05:31:56Z",
          "externalId": "<string>",
          "labels": {},
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "score": 123,
        "feedbackCount": 123,
        "assignments": [
          {
            "type": "tool",
            "tool": {
              "id": "<string>",
              "name": "<string>"
            },
            "id": "avt_01HXKD2E5NQM3T9AYWCFJE6K89"
          }
        ],
        "memoryLayerAssignments": [
          {
            "id": "avml_01HXKD2E5NQM3T9AYWCFX8AF59",
            "memoryLayer": {
              "id": "<string>",
              "name": "<string>"
            },
            "position": 123
          }
        ],
        "memoryLayerCount": 123
      }
    },
    "agentSchedule": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "schedule": {
          "calendars": [
            {
              "second": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "minute": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "hour": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfMonth": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "month": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfWeek": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "comment": "<string>"
            }
          ],
          "intervals": [
            {
              "every": "<string>",
              "offset": "<string>"
            }
          ],
          "timezone": "<string>"
        },
        "firstUserMessage": "<string>",
        "variationId": "agentvar_01HXKD2E5NQM3T9AYWCF32BSPP",
        "systemPromptData": {},
        "firstUserMessageData": {}
      },
      "info": {
        "nextFireAt": "2023-11-07T05:31:56Z",
        "lastFireAt": "2023-11-07T05:31:56Z",
        "lastObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
        "lastSkippedAt": "2023-11-07T05:31:56Z",
        "lastSkipReason": "<string>",
        "totalFires": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        }
      }
    }
  },
  "systemPrompt": "<string>",
  "firstUserMessage": "<string>",
  "stateMessage": "<string>",
  "info": {
    "totalEvents": 123,
    "totalToolCalls": 123,
    "totalInputTokens": 123,
    "totalOutputTokens": 123,
    "totalContextWindows": 123,
    "totalIterations": 123,
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    },
    "effectiveMemoryCascade": [
      {
        "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
        "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
      }
    ],
    "agent": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "labels": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "agentVariation": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "labels": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "currentContextWindowId": "objwin_01HXKD2E5NQM3T9AYWCFN7BSTR",
    "tenant": {
      "id": "tenant_01HXKD2E5NQM3T9AYWCF133E3Q",
      "externalId": "acme-corp",
      "name": "Acme Corp"
    },
    "subject": {
      "id": "subj_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "externalId": "customer-user-42",
      "name": "Jane Doe"
    },
    "widget": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "parentObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "secrets": [
    {
      "name": "<string>"
    }
  ],
  "systemPromptData": {},
  "memoryCascade": [
    {
      "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
      "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
    }
  ],
  "output": {},
  "firstUserMessageData": {},
  "episodicMemory": {
    "key": "<string>",
    "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH"
  },
  "pinnedParameters": {}
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

GET

workspaces

{workspaceId}

objectives

{id}

JavaScript

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const objective = await client.objectives.retrieve('obj_01HXKD2E5NQM3T9AYWCFQAZGFV', {
  workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});

console.log(objective.configSnapshot);

import os
from cadenya import Cadenya

client = Cadenya(
    api_key=os.environ.get("CADENYA_API_KEY"),  # This is the default and can be omitted
)
objective = client.objectives.retrieve(
    id="obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
    workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(objective.config_snapshot)

package main

import (
	"context"
	"fmt"
	"go.cadenya.com/cadenya-go"
	"go.cadenya.com/cadenya-go/option"
)

func main() {
	client := cadenya.NewClient(
		option.WithAPIKey("My API Key"),
	)
	objective, err := client.Objectives.Get(
		context.TODO(),
		"obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
		cadenya.ObjectiveGetParams{
			WorkspaceID: cadenya.String("workspace_01HXKD2E5NQM3T9AYWCF133E3Q"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", objective.ConfigSnapshot)
}

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

objective = cadenya.objectives.retrieve(
  "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)

puts(objective)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadenya.com/v1/workspaces/{workspaceId}/objectives/{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;
}

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "createdAt": "2023-11-07T05:31:56Z",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
    "labels": {},
    "externalId": "<string>"
  },
  "configSnapshot": {
    "agent": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "description": "<string>",
        "webhookEventsUrl": "<string>",
        "systemPromptDataSchema": {},
        "outputDefinition": {},
        "enableEpisodicMemory": true,
        "episodicMemoryTtl": 123
      },
      "info": {
        "variationCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        }
      }
    },
    "agentVariation": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "systemPromptTemplate": "<string>",
        "progressiveDiscovery": {
          "maxTools": 123,
          "hints": [
            "<string>"
          ]
        },
        "constraints": {
          "maxToolCalls": 123,
          "maxSubObjectives": 123,
          "inactivityTimeout": "<string>"
        },
        "description": "<string>",
        "modelConfig": {
          "modelId": "claude/opus-4.6",
          "temperature": 123
        },
        "compactionConfig": {
          "triggerThreshold": 123,
          "summarization": {
            "instructions": "<string>"
          },
          "toolResultClearing": {
            "preserveRecentResults": 123
          }
        },
        "firstUserMessageTemplate": "<string>"
      },
      "info": {
        "toolCount": 123,
        "toolSetCount": 123,
        "subAgentCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        },
        "model": {
          "id": "<string>",
          "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
          "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
          "name": "<string>",
          "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
          "createdAt": "2023-11-07T05:31:56Z",
          "externalId": "<string>",
          "labels": {},
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "score": 123,
        "feedbackCount": 123,
        "assignments": [
          {
            "type": "tool",
            "tool": {
              "id": "<string>",
              "name": "<string>"
            },
            "id": "avt_01HXKD2E5NQM3T9AYWCFJE6K89"
          }
        ],
        "memoryLayerAssignments": [
          {
            "id": "avml_01HXKD2E5NQM3T9AYWCFX8AF59",
            "memoryLayer": {
              "id": "<string>",
              "name": "<string>"
            },
            "position": 123
          }
        ],
        "memoryLayerCount": 123
      }
    },
    "agentSchedule": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "labels": {},
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "schedule": {
          "calendars": [
            {
              "second": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "minute": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "hour": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfMonth": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "month": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfWeek": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "comment": "<string>"
            }
          ],
          "intervals": [
            {
              "every": "<string>",
              "offset": "<string>"
            }
          ],
          "timezone": "<string>"
        },
        "firstUserMessage": "<string>",
        "variationId": "agentvar_01HXKD2E5NQM3T9AYWCF32BSPP",
        "systemPromptData": {},
        "firstUserMessageData": {}
      },
      "info": {
        "nextFireAt": "2023-11-07T05:31:56Z",
        "lastFireAt": "2023-11-07T05:31:56Z",
        "lastObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
        "lastSkippedAt": "2023-11-07T05:31:56Z",
        "lastSkipReason": "<string>",
        "totalFires": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "externalId": "<string>",
            "labels": {},
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>"
          }
        }
      }
    }
  },
  "systemPrompt": "<string>",
  "firstUserMessage": "<string>",
  "stateMessage": "<string>",
  "info": {
    "totalEvents": 123,
    "totalToolCalls": 123,
    "totalInputTokens": 123,
    "totalOutputTokens": 123,
    "totalContextWindows": 123,
    "totalIterations": 123,
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "externalId": "<string>",
        "labels": {},
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>"
      }
    },
    "effectiveMemoryCascade": [
      {
        "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
        "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
      }
    ],
    "agent": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "labels": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "agentVariation": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "labels": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "currentContextWindowId": "objwin_01HXKD2E5NQM3T9AYWCFN7BSTR",
    "tenant": {
      "id": "tenant_01HXKD2E5NQM3T9AYWCF133E3Q",
      "externalId": "acme-corp",
      "name": "Acme Corp"
    },
    "subject": {
      "id": "subj_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "externalId": "customer-user-42",
      "name": "Jane Doe"
    },
    "widget": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "parentObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "secrets": [
    {
      "name": "<string>"
    }
  ],
  "systemPromptData": {},
  "memoryCascade": [
    {
      "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
      "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
    }
  ],
  "output": {},
  "firstUserMessageData": {},
  "episodicMemory": {
    "key": "<string>",
    "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH"
  },
  "pinnedParameters": {}
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

The most-called read in the API. You create an objective, it works in the background, and this is how you find out where it got to.

const objective = await client.objectives.retrieve(objectiveId, { workspaceId });

console.log(objective.state);         // 'STATE_WAITING'
console.log(objective.stateMessage);  // ''

objective, err := client.Objectives.Get(ctx, objectiveID,
	cadenya.ObjectiveGetParams{WorkspaceID: cadenya.String(workspaceID)})

fmt.Println(objective.State)        // STATE_WAITING
fmt.Println(objective.StateMessage) // ""

objective = cadenya.objectives.retrieve(objective_id, workspace_id: workspace_id)

puts objective.state         # STATE_WAITING
puts objective.state_message # ""

curl "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/objectives/${OBJECTIVE_ID}" \
  -H "Authorization: Bearer ${CADENYA_API_KEY}"

The seven states

State	Meaning	Terminal
`STATE_PENDING`	Accepted, not yet started	no
`STATE_RUNNING`	The agent is working	no
`STATE_WAITING`	Answered, waiting for your next turn	no
`STATE_FINALIZED`	Produced its structured output	yes
`STATE_CANCELLED`	A caller cancelled it	yes
`STATE_TIMED_OUT`	Hit the inactivity timeout	yes
`STATE_FAILED`	Errored out	yes

STATE_WAITING is the one that trips people. It is not terminal. An agent that answers your message and expects a reply parks in WAITING, and an agent with no outputDefinition parks there for good, because it has no structured output to finalize on. If you poll for STATE_FINALIZED on such an agent, you poll forever. Poll for a terminal state, or watch for WAITING when you are driving a conversation.

`output` populates only on `STATE_FINALIZED`

output is a field on the objective, but it is empty until the objective finalizes, so it is omitted from the response on a pending, running, or waiting one. Read it back on a finalized objective:

const objective = await client.objectives.retrieve(objectiveId, { workspaceId });
if (objective.state === 'STATE_FINALIZED') {
  console.log(objective.output);  // the structured result, matching the agent's outputDefinition
}

The same result is mirrored on the finalized event, so if you are already reading events or a webhook, take it from finalized.output there rather than making a second call:

for await (const event of await client.objectives.listEvents(objectiveId, { workspaceId })) {
  if (event.data?.type === 'finalized') {
    console.log(event.data.finalized.output);  // same structured result
  }
}

An objective whose agent has no outputDefinition never finalizes, so its output never populates; it ends in STATE_WAITING.

What the response does carry

systemPrompt is the rendered prompt, with system_prompt_data. interpolated. Create an objective with systemPromptData: { company: 'Acme' } against a variation templated on {{ system_prompt_data.company }}, and this reads back "Serve Acme.", not the template. It is the exact prompt the agent ran on. configSnapshot is the agent and variation frozen at creation. This is why an objective is stable: edit the variation afterward and running objectives keep the config they started with. Read configSnapshot.agentVariation to see which variation served the run. secrets is always redacted to [] on a read, the same as everywhere. memoryCascade and info.effectiveMemoryCascade describe the layers the run resolves keys against.

`info` needs no opt-in

includeInfo is a no-op on this endpoint. The full info block returns on every request: totalEvents, totalToolCalls, totalInputTokens, totalOutputTokens, totalContextWindows, totalIterations, currentContextWindowId, agent, agentVariation, createdBy, and effectiveMemoryCascade. Those counts are the cheap way to watch progress without pulling the event history: totalIterations climbs as the agent loops, totalToolCalls as it acts.

Fetch by your own ID

Objectives take an external ID. Tag one with a ticket number at creation and fetch it back by that, never storing a Cadenya ID:

await client.objectives.create({
  workspaceId,
  agentId: 'external_id:support',
  metadata: { externalId: 'ticket-4242' },
  systemPromptData: { company: 'Acme' },
  firstUserMessage: 'My order never arrived.',
});

const objective = await client.objectives.retrieve('external_id:ticket-4242', { workspaceId });

A nonexistent ID, in either form, is a 404.

List objective events

Where the finalized event, and the output, live.

Stream objective events

Watch the run instead of polling this endpoint.

Continue an objective

The next turn, when state is WAITING.

Create an objective

outputDefinition, and what lets a run finalize.

Authorizations

Authorization

string

header

required

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

Path Parameters

workspaceId

string

required

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

string

required

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

Response

Objective is the data for an objective. It contains the snapshotted fields for the selected agent and variation. Secrets are returned only with their names, and the output definition is copied from the agent's configuration.

metadata

object

required

Metadata for ephemeral operations and activities (e.g., objectives, executions, runs)

Show child attributes

configSnapshot

object

required

The snapshot of the agent and the variation selected (either explicitly or by sampling) will be set here. Cadenya stores the point-in-time snapshot of the configuration used to start an objective and maintains it throughout the entire lifecycle so that changes to agents and variations in the middle of a cycle don't impact the objective itself

Show child attributes

state

enum<string>

required

read-only

The current lifecycle state of the objective.

Available options:

STATE_UNSPECIFIED,

STATE_PENDING,

STATE_RUNNING,

STATE_WAITING,

STATE_FAILED,

STATE_CANCELLED,

STATE_FINALIZED,

STATE_TIMED_OUT

systemPrompt

string

required

read-only

system_prompt is read-only, derived from the selected variation's prompt

firstUserMessage

string

required

The first user message in the LLM chat history, either provided explicitly at creation or rendered from the variation's first_user_message_template.

stateMessage

string

read-only

Optional human-readable detail about the current state (e.g. a failure reason).

info

object

Read-only aggregated info about this objective's execution

Show child attributes

parentObjectiveId

string

read-only

A parent objective means the objective was spawned off using a separate agent to complete an objective

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

secrets

object[]

Secrets that can be used in the headers for tool calls using the secret interpolation format.

Show child attributes

systemPromptData

object

read-only

Arbitrary data rendered into the variation's system_prompt_template

memoryCascade

object[]

Memory layers/entries layered over the baseline cascade inherited from the selected variation — element-level rules over inherited styles, in CSS terms.

Array order is resolution order: EARLIER elements are more specific and are consulted first. Entries pinned via memory_entry_id behave as single-entry layers at their position.

System-managed layers (e.g., episodic) cannot be referenced here; they attach themselves automatically based on the episodic key.

Size cap: the TOTAL effective cascade (this field + the variation's memory layer assignments) must not exceed 10 entries. A request that would produce a larger cascade is rejected with InvalidArgument.

Show child attributes

output

object

read-only

The output of the objective, populated when the objective completes. Will match the schema of output_json_schema or output_json_inferred. This will only be set if the state of the objective is set to STATE_FINALIZED

firstUserMessageData

object

read-only

Arbitrary data rendered into the variation's first_user_message_template

episodicMemory

object

If the agent variation that is selected has episodic memory enabled, then this key is used to create/update a memory layer specific to the episodic memory. The layer may have a TTL configured by the variation.

Show child attributes

pinnedParameters

object

read-only

Parameters forced onto this objective's tool calls, as provided at creation. See CreateObjectiveRequest.pinned_parameters for semantics.

Show child attributes

​The seven states

​output populates only on STATE_FINALIZED

​What the response does carry

​info needs no opt-in

​Fetch by your own ID

​Related

List objective events

Stream objective events

Continue an objective

Create an objective

Authorizations

Path Parameters

Response

The seven states

`output` populates only on `STATE_FINALIZED`

What the response does carry

`info` needs no opt-in

Fetch by your own ID

Related