Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

Response

Task queue compaction successfully completed.

status
enum<string>
required

Outcome of the compaction operation.

Available options:
enqueued,
processing,
succeeded,
failed,
canceled
Example:

"processing"

preSize
string

Size of the task queue database before compaction.

postSize
string

Size of the task queue database after compaction.

actionRequired
string | null

Follow-up action required after a successful compaction.

errorMessage
string | null

Error message if compaction failed.