API Testing
Explore and exercise the live platform API. Use the embedded Swagger UI to send real requests, read the quick reference for HTTP methods and status codes, then import the OpenAPI spec into Postman or Insomnia.
Live API explorer (Swagger UI)
Try endpoints with “Try it out”. If the frame is blocked by your browser, use the Swagger button above.
HTTP methods
| Method | When to use | Idempotent |
|---|---|---|
| GET | Read a resource. No body. Safe to repeat. | Yes |
| POST | Create a resource or run an action. Sends a body. | No |
| PUT | Replace a resource fully with the sent body. | Yes |
| PATCH | Update part of a resource. | No |
| DELETE | Remove a resource. | Yes |
Status codes
200 OKRequest succeeded; response has the data.
201 CreatedResource created (usually after POST).
400 Bad RequestInvalid input; check the request body/params.
401 UnauthorizedMissing or invalid auth token.
403 ForbiddenAuthenticated but not allowed (e.g. non-admin).
404 Not FoundResource or route does not exist.
422 UnprocessableValidation failed (FastAPI schema error).
429 Too Many RequestsRate/usage limit reached.
500 Server ErrorBug or unhandled error on the backend.
Auth & testing notes
- Protected and admin endpoints need a JWT. Get one from POST /api/auth/login, then send it as Authorization: Bearer <token>.
- Base URL: https://qa.flow-ai.work. All app routes are under /api.
- To test in Postman/Insomnia: import https://qa.flow-ai.work/openapi.json — every endpoint, schema, and example loads automatically.
- Validation errors return 422 with a JSON list of the exact fields that failed — read them before retrying.