OpenObserve API

Name: OpenObserve API
Brand: OpenObserve API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsMonitoring Observabilitybasic9 EndpointsREST

For Agents

Ingest logs and metrics into OpenObserve, manage streams, and run search queries against an organization's observability data.

Install Jentic One Beta

Connect the OpenObserve API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the OpenObserve API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fopenobserve.ai%2Fopenobserve" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fopenobserve.ai%2Fopenobserve" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with OpenObserve API.

Ingest JSON log events into a named stream via the _json ingestion endpoint

Push metrics in JSON form for time-series storage and dashboarding

List, retrieve, and delete streams under a tenant organization

GET STARTED

Start building with OpenObserve API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use OpenObserve API for, with concrete tasks.

★ Centralised application log ingestion

Self-hosted services push structured JSON logs into a tenant-scoped stream so engineers can search and correlate events across microservices. OpenObserve handles indexing and time-bucketed storage, and the ingestion endpoint accepts arbitrary JSON event payloads. Setup typically takes a few hours once an OpenObserve instance is running and credentials are issued.

POST a batch of 50 JSON log events to /api/{organization}/{stream}/_json with HTTP Basic auth and confirm a 200 response.

Time-range search for incident investigation

On-call engineers query OpenObserve for events within a specific window to investigate an incident. The data_by_time_range endpoint returns matching events for a stream, and the status endpoint reports when an asynchronous job is complete. This replaces ad-hoc grep over scattered log files with a structured query interface.

Submit a data_by_time_range query for the last 30 minutes against the api-errors stream, then poll /status/{jobId} until the job completes.

Custom metrics ingestion from services

Internal services emit custom metrics directly to OpenObserve via the metrics JSON ingestion endpoint, avoiding the need for a separate StatsD or Prometheus pipeline. Metrics are stored alongside logs and traces under the same organization scope, simplifying operator authentication.

POST a metrics payload with name, value, and timestamp fields to /api/{organization}/ingest/metrics/_json and verify acceptance.

Agent-driven observability through Jentic

AI agents that triage production incidents call OpenObserve via Jentic to fetch relevant logs and metrics for a given service window. Jentic resolves the right ingestion or search operation based on the agent's intent and injects the operator's credentials at execution time so the raw username and password never appear in agent context.

Search Jentic for 'search openobserve logs', load the search operation schema, and execute a query for stream=api-errors over the last hour.

Key Endpoints

9 endpoints — jentic publishes the only available openapi specification for openobserve api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/api/{organization}/{stream}/_json

Ingest JSON log events into a stream

POST

/api/{organization}/ingest/metrics/_json

Ingest metrics in JSON form

POST

/api/{organization}/_search

Run a search query across an organization

POST

/api/{organization}/streams/{streamName}/data_by_time_range

Submit a time-range search job

GET

/api/{organization}/streams/{streamName}/data_by_time_range/status/{jobId}

Poll status of a time-range search job

GET

/api/{organization}/streams

List streams in an organization

POST

/api/{organization}/{stream}/_json

Ingest JSON log events into a stream

POST

/api/{organization}/ingest/metrics/_json

Ingest metrics in JSON form

POST

/api/{organization}/_search

Run a search query across an organization

POST

/api/{organization}/streams/{streamName}/data_by_time_range

Submit a time-range search job

GET

/api/{organization}/streams/{streamName}/data_by_time_range/status/{jobId}

Poll status of a time-range search job

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the OpenObserve API by hand means pointing at your instance host, sending Basic auth on every request, and threading the organization and stream segments through each ingestion and search call. Through Jentic you install once, import the OpenObserve API from the API Directory, store the credentials once, and your agent calls it.

Permission scoping

You limit the agent to the operations it needs, such as ingesting JSON logs or running a search over a time range. You choose which of the ingestion and search operations it may call, and any you do not grant stay out of reach.

Credential isolation

Your OpenObserve Basic-auth username and password are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'send logs to OpenObserve' or 'search OpenObserve by time range', and Jentic returns the matching ingestion or search operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using OpenObserve API through Jentic.

Why is there no official OpenAPI spec for OpenObserve API?

OpenObserve does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call OpenObserve API via structured tooling. It is validated against the live API and kept up to date. get started with Jentic One, the self-hosted execution layer.

What authentication does the OpenObserve API use?

OpenObserve uses HTTP Basic authentication, passing base64-encoded username and password in the Authorization header on every request. Through Jentic, the credentials sit in the encrypted vault and the agent never sees the raw values; Jentic injects the Basic header at execution time.

Can I ingest both logs and metrics with the OpenObserve API?

Yes. Logs are pushed as JSON events to /api/{organization}/{stream}/_json, and metrics use the dedicated /api/{organization}/ingest/metrics/_json endpoint. Both are scoped to an organization tenant in the same instance.

What are the rate limits for the OpenObserve API?

Because OpenObserve is self-hosted, rate limits are governed by the operator's instance configuration rather than a central vendor quota. Plan ingestion volume against the resources of your specific deployment.

How do I run a time-range search through Jentic?

Search Jentic for 'search openobserve by time range', load the operation that matches /api/{organization}/streams/{streamName}/data_by_time_range, and execute it with start/end timestamps. Jentic returns the jobId, and a follow-up call to the status endpoint retrieves the results when ready.

Why is the base URL in the spec a placeholder?

OpenObserve runs as a self-hosted platform, so the spec uses {instance} as a server variable. Set it to the URL of your own OpenObserve deployment (for example, https://logs.example.com) when configuring the operation through Jentic.

OpenObserve API

Connect the OpenObserve API to your agent

Capabilities

Start building with OpenObserve API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs