Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
project_id
string
required
env_id
string
required

Query Parameters

component
null | enum<string>

Which component's logs to fetch. Shared vocabulary with GET /preview/logs (which 501s on workforce). workforce here covers agent and workflow components interchangeably. Resolves to the component's most recent deployment. Mutually exclusive with deployment_id; exactly one of the two must be provided. Routing selector for the deployable units a Timbal project owns: the project-level frontend (Ui), the project-level backend (Api), and the N workforce components (Workforce, keyed on manifest_id).

Used as a ?component= query parameter on every surface that acts on one component at a time (GET /preview/logs, GET /envs/{env}/logs, etc.). Wire values are lowercase (ui/api/workforce). Surfaces that don't apply to a given variant (e.g. previews don't run workforce components today) reject with 501 NotImplemented instead of forking the schema — clients rely on a single shared vocabulary.

Distinct from [AppType], which is a type discriminator on workforce rows (Agent vs Workflow) carried in response payloads. ProjectComponent collapses both into Workforce because every surface that selects a workforce component keys on manifest_id, not on the Agent-vs-Workflow distinction (the underlying log pipeline, deployment shape, etc. are identical for both). Use [From<AppType>] to bridge: any workforce type — including the forward-compat AppType::Unknown catch-all — maps to ProjectComponent::Workforce.

Available options:
ui,
api,
workforce
deployment_id
string | null

Fetch logs for one specific deployment (the id field in the deployments-list response) instead of the component's latest. Lets you read the runtime output of a failed or superseded deployment post-mortem. Mutually exclusive with component.

component_id
string | null

Numeric workforce app id (the value the SDK reads from TIMBAL_APP_ID, also returned as id on each deployment in the deployments-list response). XOR with component_uid when component=workforce; forbidden for ui / api.

component_uid
string | null

Workforce manifest uid (the _id field in timbal.yaml, also returned as uid on each deployment in the deployments-list response). XOR with component_id. Display name is deliberately not accepted as a selector — it's user-editable and not guaranteed unique within a project.

start_time
integer<int64> | null

ms since epoch. Defaults to end_time - 1h.

end_time
integer<int64> | null

ms since epoch. Defaults to now.

limit
integer | null

Defaults to 50.

Required range: x >= 0
page_token
string | null

Pagination cursor from a prior response. Returned only when cursor-based pagination is available for the component's runtime; ignored otherwise.

Response

Logs fetched

Resolved window echoed back so the client can paginate / refresh without re-deriving the defaults the server applied.

end_time
integer<int64>
required
events
object[]
required
limit
integer
required
Required range: x >= 0
start_time
integer<int64>
required
next_page_token
string | null