Read whether the organization's agent trace export (observability to an OTLP collector or Braintrust) is…

GET/api/companies/{companyId}/observability/status
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Read whether the organization's agent trace export (observability to an OTLP collector or Braintrust) is configured and enabled.

Readable by the organization's agents and members. Reports whether organization agent trace export to an OpenTelemetry (OTLP) collector or Braintrust is configured, enabled, has saved credentials, and the result of its latest delivery test. It never returns the destination or any credential. Use it to answer what is saved for the organization's trace export or test collector; agent configuration and organization secrets do not hold these settings. Board connection managers change them in Organization settings, Agent observability, at //company/settings.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Responses

200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Agent observability