Hi. Is there an API documentation at OpenRefine user manual | OpenRefine or somewhere else outside the codebase? I'm not able to find one.

Hi. Is there an API documentation at OpenRefine user manual | OpenRefine or somewhere else outside the codebase? I'm not able to find one. The internal REST API isn't supported for external use (and thus isn't documented), although this has been a requested feature. The Java API for extension wr…

The Java API as a REST API, from what you described. I'm looking to automate, at least one, workflow(s) with the help of tools like n8n . I have streamlined all of the steps and need very minimal manual intervention somewhere in the middle, depending on a facet. Thus, I need the API to interact to -…

Using Swagger/OpenAPI to document the REST API is a good suggestion since it's pretty much the de facto standard these days. It's not undocumented due to a lack of tooling though. It's undocumented because we haven't committed to supporting it for external use with all the API stability guarantees, …

In the case of OpenRefine, I think we can have a "loose" stability clause in our documenting with OpenAPI because OpenRefine and any tooling against it would likely slowly evolve. I wouldn't expect wild drastic changes even over the next 10 years. And I think most folks that use OpenRefine's API u…

API documentation

Support and Helpdesk

DaxServer August 26, 2024, 8:34am 4

Referring to my earlier comment at "Scheduling breaking changes we have on our radar", I think adopting OpenAPI specification to build a REST API would be beneficial in achieving such a public API.

Topic		Replies	Views
OpenRefine 2024 Barcamp: Support OpenAPI in OpenRefine Development & Design barcamp-2024	0	91	July 9, 2024
Developer and Community Engagement update: April 2025 Community	10	246	May 21, 2025
Improving the documentation with a new section, “External tools and Services” OpenRefine documentation	8	182	November 7, 2024
About the OpenRefine documentation category OpenRefine documentation	0	384	October 28, 2022
Developer and Community Engagement update: May 2025 Community	0	84	June 5, 2025

API documentation

Related topics