v1

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Miscellaneous

Get mutation status

Get the status for an asynchronous mutation to know whether or not it has been completed. Each API endpoint that mutates a document will return a request id that you can pass to this endpoint to check the completion status. Status information is not guaranteed to be available for more than one day after the mutation was completed. It is intended to be used shortly after the request was made.

get/mutationStatus/{requestId}

Path parameters

requestIdstring required

ID of the request.

Response

Info about the mutation.

completedboolean required

Returns whether the mutation has completed.

warningstring

A warning if the mutation completed but with caveats.

Example response

{
  "completed": true,
  "warning": "Initial page HTML was invalid."
}