Skip to main content

​
Request format

All Sutro endpoints follow REST principles and use standard HTTP methods (GET, POST, PUT, DELETE). Most requests return a response within milliseconds containing the result of the requested action.

​
Long-running operations

Some operations—such as generating an application from uploaded attachments—take longer to complete. Sutro uses a Request–Monitor–Retrieve pattern for long-running operations:
  1. Request — Send a standard HTTP request to start the action. The API responds immediately, confirming that the operation has begun.
  2. Monitor — Poll a status endpoint to check progress. Continue polling until the status returns Complete.
  3. Retrieve — Once complete, send a follow-up request to the specified endpoint to obtain the final results.
Webhooks coming soon. With webhooks, polling won’t be necessary and Sutro will notify you automatically when an action completes.

​
Response format

Sutro follows REST conventions for responses. Successful requests return 2xx status codes with JSON payloads containing the requested data or operation confirmation.

​
Error codes

​
4xx – Client errors

These indicate an issue with the request itself.

​
5xx – Server errors

These indicate an issue on Sutro’s side.
Always log both the HTTP status and the error payload from the response. This helps you debug client-side issues and improves support turnaround if you need to escalate.