Design capture upload begin

POST/v1/design/captures/uploads

Signed-in sessionLaunch key product.designOperation design_capture_upload_begin

An internal tool for the components agents build and the rules they follow.

Body

expectedAuthorizationVersionstring
sha256stringRequired
sizeBytesnumberRequired
mimestringRequired
idempotencyKeystringRequired
filenamestringRequired
folderIdstringRequired

Returns

idstringRequired
fileIdstringRequired
phase"available" | "blocked" | "canceled" | "canceling" | "reserved" | "transferring" | "verifying"Required
retryablebooleanRequired
expiresAtnumberRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

POST/v1/design/captures/uploads

curl "$SPECIFY_API_ORIGIN/v1/design/captures/uploads" \
  -X POST \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>" \
  -H "Content-Type: application/json" \
  -d '{"sha256":"<sha256>","sizeBytes":1,"mime":"<mime>","idempotencyKey":"retry-1","filename":"<filename>","folderId":"<folderId>"}'

Response

{
  "result": {
    "id": "<id>",
    "fileId": "<fileId>",
    "phase": "available",
    "retryable": true,
    "expiresAt": 1
  }
}

Design capture upload begin

Headers

Body

Returns

Errors