Logs
2 methods on the Logs resource.
2 methods · 0 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";2 of 2
listLogs
List runtime logs
compozy.logs.listLogs({ query }) → Promise<LogsListResponse>
Options
- workspace_idstringquery
- Workspace id
- session_idstringquery
- Session id
- agent_namestringquery
- Agent name
- typestringquery
- Event type
- runstringquery
- Task run id
- actorstringquery
- Actor as kind:id
- actor_kindstringquery
- Actor kind
- actor_idstringquery
- Actor id
- providerstringquery
- Provider id projected at event write time
- outcomestringquery
- Event registry outcome
- componentstringquery
- Event registry component
- error_onlybooleanquery
- Return warning and failure outcomes only
- after_seqintegerquery
- Return rows after this event summary sequence
- sincestringquery
- Only logs emitted since this timestamp
- limitintegerquery
- Maximum number of records to return
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/logsapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.logs.listLogs();streamLogs
Stream runtime logs
compozy.events("streamLogs", { query }) → AsyncIterable<StreamEvent<SseFrame<"streamLogs">>>
Options
- workspace_idstringquery
- Workspace id
- session_idstringquery
- Session id
- agent_namestringquery
- Agent name
- typestringquery
- Event type
- runstringquery
- Task run id
- actorstringquery
- Actor as kind:id
- actor_kindstringquery
- Actor kind
- actor_idstringquery
- Actor id
- providerstringquery
- Provider id projected at event write time
- outcomestringquery
- Event registry outcome
- componentstringquery
- Event registry component
- error_onlybooleanquery
- Return warning and failure outcomes only
- after_seqintegerquery
- Return rows after this event summary sequence
- sincestringquery
- Only logs emitted since this timestamp
- limitintegerquery
- Maximum number of records to return
- replaybooleanquery
- Replay bounded retained logs before live polling
- last_event_idstringquery
- Composite resume cursor when Last-Event-ID cannot be set; the header takes precedence
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/logs/streamapp tokens denied
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();for await (const frame of compozy.events("streamLogs", {})) { console.log(frame);}