API Reference
The Prefactor Platform (P2) API gives you a few different ways to explore and integrate with the platform, depending on how you like to work.
Platform API docs
Section titled “Platform API docs”If you prefer a guided, narrative view, start with the generated Platform API docs. These live documentation pages walk through the available resources and endpoints in a structured way:
- Platform API docs: Platform API
Swagger UI
Section titled “Swagger UI”For an interactive way to try requests in the browser, use the Swagger UI. It lets you inspect endpoints, parameters, and responses, and execute calls against the API directly:
- Swagger API docs: P2 Swagger UI
OpenAPI schema
Section titled “OpenAPI schema”If you’re working with API clients or generating code, you can use the raw OpenAPI schema. Import it into tools like Postman or Insomnia, or feed it into code generation workflows to quickly scaffold your integration:
- Raw OpenAPI document: P2 OpenAPI JSON