canonical: https://jentic.com/apis/osisoft.com/osisoft # OSIsoft PI Web API The OSIsoft PI Web API reads the time-series values and asset model held in a PI System, so an application can pull sensor and process data and browse the assets it belongs to. It exposes PI points and streams whose recorded, interpolated, and current values can be read over a time range, and an asset framework of elements and attributes that can be searched and browsed. Event frames capture periods of interest such as a batch or a downtime, and calculation endpoints summarise values over a window. This page targets the public PI Web API sample server, which serves read-only demonstration data. ## For AI agents Read recorded, interpolated, and current values from PI System streams and points, search the asset framework of elements and attributes, and retrieve event frames in the OSIsoft PI Web API. This targets the public sample server, which serves read-only data and needs no API key. ## Scope Does not handle PI System administration, licensing, or real-time control of equipment. Use for reading PI System time-series values, assets, and event frames only. ## Capabilities - Read recorded values from a PI System stream over a time range - Read the current and interpolated value of a PI point or stream - Look up PI points and their metadata - Search the asset framework for elements and attributes - Browse asset databases, elements, and their attributes - Retrieve event frames that mark periods of interest - Evaluate summary calculations over a stream's values ## Use cases ### Agent-Driven Sensor Data Retrieval An AI agent connected through Jentic reads recorded or current values from a PI System stream and returns them in a report, so a human can ask for process data in plain language and get an answer without opening the PI tools. The agent looks up the point or element first, then reads its values over the requested window. Example prompt: Find the stream for the pump temperature point and return its recorded values for the last twenty-four hours ### Asset Framework Exploration An application browses the asset framework to map out the elements and attributes that model a plant, using search to locate an asset and then reading its attributes and their values. This lets a downstream system align PI data with equipment without a hand-maintained tag list. Example prompt: Search the asset framework for the element named 'Boiler 1' and list its attributes with their current values ### Event and Calculation Reporting A reporting workflow retrieves event frames that mark batches or downtime and evaluates summary calculations over a stream, so it can report totals and averages for each period. It reads the event frames first to bound the time ranges, then summarises the relevant streams. Example prompt: List the event frames from the last week and return the average value of the associated stream for each one ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/points/{webId}` | Get a PI point | | GET | `/streams/{webId}/recorded` | Get recorded stream values | | GET | `/streams/{webId}/value` | Get the current stream value | | GET | `/elements/search` | Search asset framework elements | | GET | `/attributes/search` | Search asset framework attributes | | GET | `/system/status` | Get PI Web API system status | ## Key resources - **Points** — PI points, the individual tags whose current and historical values can be read - **Streams** — The time-series values of a point or attribute, readable as recorded, interpolated, or current - **Elements and Attributes** — The asset framework that models equipment as searchable elements with attributes - **Event Frames** — Records that capture periods of interest such as a batch, an alarm, or downtime ## Why Jentic - **Setup:** Wiring the OSIsoft PI Web API by hand means learning its WebID addressing, the difference between streams and stream sets, and how to page a large asset hierarchy. Through Jentic you install once, import the PI Web API from the API Directory, and your agent calls it; the public sample server needs no key to configure. - **Permission scoping:** You choose which operations your agent may call, so you can allow read operations such as fetching recorded stream values and searching elements while leaving out any write operations. The sample server is read-oriented, so the agent retrieves data and does not change the PI System, and every call it makes is logged. - **Credential handling:** The public PI Web API sample server needs no API key or token, so there is nothing sensitive to hold. Jentic calls its read-only endpoints directly on your behalf, and any production deployment's own authentication is configured on the server rather than in the agent. - **Discovery method:** Agents search Jentic by intent such as 'get recorded values for a stream' or 'search for an element', and Jentic returns the matching PI Web API operation with its input schema so the agent calls the right endpoint without reading the reference docs. ## Related APIs - **ThingsBoard API** — IoT platform for device telemetry collection, storage, and dashboarding - **Particle API** — Device cloud for connected hardware that publishes and reads device data ## FAQ ### Is there an OSIsoft PI Web API MCP server? You don't need an MCP server to give your agent the OSIsoft PI Web API. Jentic connects it directly from the API Directory: import it and your agent can read PI System values and assets straight away, with no extra server to run and no tool definitions to load into the agent's context. ### Can I limit what my agent is allowed to do with the OSIsoft PI Web API? Yes. You choose which operations your agent may call, so you can allow the read operations like fetching recorded stream values and searching elements while leaving out anything that writes to the PI System. Every call the agent makes is logged, so you can see exactly what it read. ### What authentication does the OSIsoft PI Web API use? The public PI Web API sample server targeted here declares no security scheme in its OpenAPI spec, so its read-only endpoints are called directly with no API key or token. Production PI Web API deployments add their own authentication, which is configured on the server rather than in the spec. ### Can I read historical sensor values with the OSIsoft PI Web API? Yes. The API reads recorded, interpolated, and current values from a stream over a time range, so an agent can retrieve the history of a PI point as well as its latest value. You can also summarise values over a window using the calculation endpoints. ### What are the rate limits for the OSIsoft PI Web API? The OpenAPI spec does not specify rate limits for the OSIsoft PI Web API. For current guidance, see the PI Web API documentation at https://docs.aveva.com. ### How do I read PI System data through Jentic? Import the OSIsoft PI Web API from the Jentic API Directory, then have your agent issue a request such as 'get the recorded values for this point over the last day'. Jentic matches the intent to the right read operation and returns its input schema so the agent builds the correct request. To run it on your own infrastructure, install Jentic One from its GitHub repo.