What is an openAPI?
OpenAPI is a standard file that describes every address and option of a service, so people and software can learn how to use it without guessing.
In plain words
A building has a floor plan. It shows every room and where the doors are. An OpenAPI file is a floor plan for a service. It lists each address, what it needs, what it gives back and what the errors look like.
It is written for machines first, which makes it powerful. Tools can read it to build ready-made code, check requests or produce a neat reference page. AI agents can also read it to understand what a service can do.
For a business owner the benefit is quiet but real. It means that whoever builds on a service, whether a developer or an AI agent, starts from the same accurate description, so fewer things go wrong.
You will never need to open one. If a developer asks "is there an OpenAPI file?", the answer is a helpful yes or no, and it is a good sign when there is one.
How it works in Spaces
Spaces publishes its OpenAPI file at https://api.spacesos.com/openapi.json.
It describes the REST API at https://api.spacesos.com/v1. The human-readable API reference is on the Spaces docs.
Related terms
- REST API: A REST API is a way for software to talk to a service by sending ordinary web requests to named addresses and getting answers back.
- API: An API, or application programming interface, is a set of rules that lets one piece of software ask another to do something, such as send a message or list your conversations.
- Endpoint: An endpoint is one specific web address on a service that does one particular job, such as listing your chats or sending a reply.
- SDK: An SDK, or software development kit, is a ready-made toolbox of code that makes it easier for a programmer to work with a service.
- JSON: JSON is a simple, tidy way of writing information as labelled items so that both people and programs can read it.
FAQ
Where is the Spaces OpenAPI file?
At https://api.spacesos.com/openapi.json.
Do I need to read it?
No. It is for developers and tools. The docs give the same facts in plain words.
Is OpenAPI the same as MCP?
No. OpenAPI describes a web API. MCP is how AI agents find and use a service's tools. Spaces offers both.
Useful next: API reference, Docs, AI agents that work with Spaces. Every term: the glossary.