Skip to content
SIBISIBI Developers
Esc
↑↓navigate↵open⌘Jpreview

Create export

Starts an export of every asset the caller can see into one gzipped JSON Lines file, one asset per line in the same shape GET /assets/{id} serves. The export runs in the background: this responds 202 with the export in in_progress status and a Location header for it. Poll GET /assets/exports/{id} until the status is succeeded, then fetch download.url. Only one export can be in progress per organization at a time; a second request while one is in_progress responds 409 naming the running export. No request body.

POST/exports
Authorization
AuthorizationBearer token · headerrequired

A Sibi Public API token or access token, sent as Authorization: Bearer <token>.

Scopes:create:asset-exports
Responses
202

The export has been queued

idstringrequired

Sibi assigned identifier for this export.

statusstringrequired

in_progress (the export is queued or the file is being written), succeeded (the file is ready to download), or failed (see error).

Allowed:in_progresssucceededfailed
createdAtstring<date-time>required

When the export was requested.

startedAtstring<date-time>

When work on the file began. Absent while the export is still queued.

completedAtstring<date-time>

When the export succeeded or failed.

rowCountinteger

The number of assets in the file. Present once the export has succeeded.

min 0
fileSizeinteger

The size of the compressed file in bytes. Present once the export has succeeded.

min 0
downloadExportDownload

How to fetch the file. Present only while the export is succeeded.

Show properties
urlstring<uri>required

A signed URL for the export file. It is valid until expiresAt; read the export again for a fresh one.

methodstringrequired
Allowed:GET
expiresAtstring<date-time>required

When this download URL stops working.

errorobject

Why the export failed. Present only when the export is failed.

Show properties
codestringrequired
messagestringrequired
401

The Authorization header is missing, or the bearer token could not be resolved (invalid, expired, or revoked)

codestringrequired

Machine-readable error code

Allowed:UNAUTHORIZED
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

403

The token is missing the scope this operation requires (INSUFFICIENT_SCOPE), is a GraphQL token rather than a REST API token (REST_TOKEN_REQUIRED), or it was minted for the other environment (TOKEN_ENVIRONMENT_MISMATCH)

codestringrequired

Machine-readable error code

Allowed:INSUFFICIENT_SCOPEREST_TOKEN_REQUIREDTOKEN_ENVIRONMENT_MISMATCH
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

409

An export is already in progress for the caller’s organization (EXPORT_IN_PROGRESS). Poll that export instead; a new one can be requested once it has succeeded or failed

codestringrequired
Allowed:EXPORT_IN_PROGRESS
messagestringrequired
exportIdstringrequired

The id of the export already in progress.

requestIdstring
500

Internal server error

codestringrequired

Machine-readable error code

Allowed:INTERNAL_SERVER_ERROR
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

503

The token-exchange service is unavailable or misconfigured — retry shortly. Not a token problem.

codestringrequired

Machine-readable error code

Allowed:AUTH_UNAVAILABLE
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

Try it
Server
Authorization
Request
curl -X POST "https://api.sibipro.com/assets/exports" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "id": "ae_aBcD1234",
  "status": "in_progress",
  "createdAt": "2019-08-24T14:15:22Z",
  "startedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z",
  "rowCount": 0,
  "fileSize": 0,
  "download": {
    "url": "http://example.com",
    "method": "GET",
    "expiresAt": "2019-08-24T14:15:22Z"
  },
  "error": {
    "code": "EXPORT_GENERATION_FAILED",
    "message": "string"
  }
}