> ## Documentation Index > Fetch the complete documentation index at: https://docs.stackshift.cloud/llms.txt > Use this file to discover all available pages before exploring further. # Assets API > Object storage, uploads, transformations, delivery, media processing, and asset operations. Object storage, uploads, transformations, delivery, media processing, and asset operations. Base URL: `https://api.stackshift.cloud/api/v1` Authentication: `bearer`. Every operation below is traced to an official SDK source file listed in the generated coverage report. | Method | SDK route | SDK method | Request type | Response type | | -------- | ---------------------------------------------------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | `POST` | `/assets/upload` | `AssetsClient.upload` | `{ file: Blob; options?: AssetUploadOptions }` | `Asset` | | `POST` | `/assets/upload-sessions` | `AssetsClient.createUploadSession` | `AssetSignedUploadUrlOptions` | `AssetSignedUploadUrl` | | `GET` | `/assets/upload-sessions/{sessionID}` | `AssetsClient.resumeUploadSession` | `string` | `AssetSignedUploadUrl` | | `POST` | `/assets/upload-sessions/{sessionID}/complete` | `AssetsClient.completeUploadSession` | `string` | `Asset` | | `DELETE` | `/assets/upload-sessions/{sessionID}` | `AssetsClient.cancelUploadSession` | `string` | `{ cancelled: boolean }` | | `POST` | `/assets/upload-url` | `AssetsClient.signedUploadUrl` | `AssetSignedUploadUrlOptions` | `AssetSignedUploadUrl` | | `POST` | `/assets/buckets` | `AssetsClient.createBucket` | `AssetBucketInput & { name: string }` | `AssetBucket` | | `GET` | `/assets/buckets` | `AssetsClient.listBuckets` | `None` | `{ buckets: AssetBucket[] }` | | `PUT` | `/assets/buckets/{bucketID}` | `AssetsClient.updateBucket` | `AssetBucketInput` | `AssetBucket` | | `DELETE` | `/assets/buckets/{bucketID}` | `AssetsClient.deleteBucket` | `string` | `void` | | `PUT` | `/assets/buckets/{bucketID}/storage` | `AssetStorageClient.configure` | `AssetStorageConfiguration` | `AssetBucket` | | `POST` | `/assets/buckets/{bucketID}/relocations` | `AssetStorageClient.relocate` | `AssetRelocationInput` | `AssetMigration` | | `POST` | `/assets/connections` | `AssetConnectionsClient.create` | `AssetConnectionInput` | `AssetConnection` | | `GET` | `/assets/connections` | `AssetConnectionsClient.list` | `None` | `AssetConnectionListResult` | | `GET` | `/assets/connections/{connectionID}` | `AssetConnectionsClient.get` | `string` | `AssetConnection` | | `PATCH` | `/assets/connections/{connectionID}` | `AssetConnectionsClient.update` | `string` | `AssetConnection` | | `POST` | `/assets/connections/{connectionID}/verify` | `AssetConnectionsClient.verify` | `string` | `AssetConnection` | | `DELETE` | `/assets/connections/{connectionID}` | `AssetConnectionsClient.delete` | `string` | `{ deleted: boolean }` | | `GET` | `/assets/s2-buckets` | `AssetStorageClient.listS2Buckets` | `None` | `AssetS2BucketListResult` | | `POST` | `/assets/s2-buckets` | `AssetStorageClient.createS2Bucket` | `{ name: string; region: string; }` | `AssetS2Bucket` | | `POST` | `/assets/migrations` | `AssetMigrationsClient.start` | `AssetMigrationInput` | `AssetMigration` | | `GET` | `/assets/migrations` | `AssetMigrationsClient.list` | `{ limit?: number }` | `AssetMigrationListResult` | | `GET` | `/assets/migrations/{migrationID}` | `AssetMigrationsClient.get` | `string` | `AssetMigration` | | `POST` | `/assets/migrations/{migrationID}/cancel` | `AssetMigrationsClient.cancel` | `string` | `{ canceled: boolean }` | | `POST` | `/assets/migrations/{migrationID}/items/{itemID}/retry` | `AssetMigrationsClient.retryItem` | `string` | `{ queued: boolean }` | | `GET` | `/assets/migrations/{migrationID}/report` | `AssetMigrationsClient.report` | `string` | `AssetMigrationReport` | | `POST` | `/assets/upload-capabilities` | `AssetUploadCapabilitiesClient.create` | `AssetUploadCapabilityInput` | `CreatedAssetUploadCapability` | | `GET` | `/assets/policy` | `AssetsClient.getPolicy` | `None` | `AssetContentPolicy` | | `PUT` | `/assets/policy` | `AssetsClient.updatePolicy` | `AssetContentPolicy` | `AssetContentPolicy` | | `POST` | `/assets/transformations` | `AssetsClient.createTransformation` | `AssetNamedTransformInput` | `AssetTransformation` | | `GET` | `/assets/transformations` | `AssetsClient.listTransformations` | `None` | `{ transformations: AssetTransformation[] }` | | `POST` | `/assets/{assetID}/transforms` | `AssetsClient.materializeTransform` | `string` | `AssetJobSubmission` | | `GET` | `/assets/{assetID}/derivatives` | `AssetsClient.derivatives` | `string` | `{ derivatives: AssetDerivedAsset[] }` | | `POST` | `/assets/generations` | `AssetsClient.generate` | `AssetImageGenerationInput` | `AssetJobSubmission` | | `GET` | `/assets/automation` | `AssetsClient.automation` | `None` | `import('./asset-workflows.js').AssetAutomationOverview` | | `POST` | `/assets/mcp` | `Assets SDK method` | `SDK request object` | `SDK response type` | | `GET` | `/assets/workflows/catalog` | `AssetWorkflowsClient.catalog` | `None` | `{ nodes: AssetWorkflowNodeDefinition[]; templates: AssetWorkflowTemplate[] }` | | `GET` | `/assets/workflows` | `AssetWorkflowsClient.list` | `None` | `AssetWorkflow[]` | | `POST` | `/assets/workflows` | `AssetWorkflowsClient.create` | `{ name: string; description?: string; template_key?: string; definition?: AssetWorkflowDefinition; layout?: AssetWorkflowLayout; }` | `AssetWorkflow` | | `GET` | `/assets/workflows/{workflowId}` | `AssetWorkflowsClient.get` | `string` | `AssetWorkflow` | | `PUT` | `/assets/workflows/{workflowId}/draft` | `AssetWorkflowsClient.updateDraft` | `{ name: string; description?: string; definition: AssetWorkflowDefinition; layout: AssetWorkflowLayout; expected_revision: number; }` | `AssetWorkflow` | | `POST` | `/assets/workflows/{workflowId}/validate` | `AssetWorkflowsClient.validate` | `string` | `AssetWorkflowValidation` | | `POST` | `/assets/workflows/{workflowId}/publish` | `AssetWorkflowsClient.publish` | `number` | `AssetWorkflowVersion` | | `POST` | `/assets/workflows/{workflowId}/activate` | `AssetWorkflowsClient.activate` | `{ versionId: string; expectedRevision: number }` | `void` | | `POST` | `/assets/workflows/{workflowId}/run` | `AssetWorkflowsClient.run` | `{ version_id?: string; input?: unknown; idempotency_key?: string; }` | `AssetWorkflowRun` | | `GET` | `/assets/workflows/{workflowId}/versions` | `AssetWorkflowsClient.versions` | `string` | `AssetWorkflowVersion[]` | | `GET` | `/assets/workflows/{workflowId}/runs` | `AssetWorkflowsClient.runs` | `string` | `AssetWorkflowRun[]` | | `GET` | `/assets/workflows/runs/{runId}` | `AssetWorkflowsClient.runDetail` | `string` | `{ run: AssetWorkflowRun; nodes: AssetWorkflowNodeExecution[] }` | | `POST` | `/assets/workflows/runs/{runId}/cancel` | `AssetWorkflowsClient.cancelRun` | `string` | `AssetWorkflowRun` | | `POST` | `/assets/workflows/runs/{runId}/retry` | `AssetWorkflowsClient.retryRun` | `string` | `AssetWorkflowRun` | | `GET` | `/assets/workflows/approvals` | `AssetWorkflowsClient.approvals` | `AssetWorkflowApproval['status']` | `AssetWorkflowApproval[]` | | `POST` | `/assets/workflows/approvals/{approvalId}/approve` | `AssetWorkflowsClient.approve` | `{ reason?: string; expires_at?: string; }` | `AssetWorkflowApproval` | | `POST` | `/assets/workflows/approvals/{approvalId}/reject` | `AssetWorkflowsClient.reject` | `{ reason?: string; }` | `AssetWorkflowApproval` | | `GET` | `/assets/workflows/connections` | `t.ListWorkflowHTTPConnections` | `None` | `AssetWorkflowHTTPConnection` | | `POST` | `/assets/workflows/connections` | `AssetWorkflowsClient.connections` | `SDK request object` | `AssetWorkflowHTTPConnection[]` | | `POST` | `/assets/workflows/connections/{connectionId}/credential/rotate` | `AssetWorkflowsClient.rotateConnectionCredential` | `AssetWorkflowHTTPCredentialInput` | `{ id: string; name: string; header: string; prefix?: string; revision: number }` | | `POST` | `/assets/workflows/{workflowId}/inbound-hook/rotate` | `AssetWorkflowsClient.rotateInboundHook` | `string` | `{ hook: { id: string; workflow_id: string; secret_version: number; enabled: boolean }; token: string; secret: string }` | | `POST` | `/assets/workflow-hooks/{token}` | `Assets SDK method` | `SDK request object` | `SDK response type` | | `DELETE` | `/assets/transformations/{name}` | `AssetsClient.deleteTransformation` | `string` | `{ deleted: boolean }` | | `POST` | `/assets/lifecycle-rules` | `AssetsClient.createLifecycleRule` | `{ name: string; prefix?: string; action: "delete" \| "expire_versions"; age_days: number; enabled?: boolean; }` | `AssetLifecycleRule` | | `GET` | `/assets/lifecycle-rules` | `AssetsClient.listLifecycleRules` | `None` | `{ lifecycle_rules: AssetLifecycleRule[] }` | | `DELETE` | `/assets/lifecycle-rules/{ruleID}` | `AssetsClient.deleteLifecycleRule` | `string` | `{ deleted: boolean }` | | `POST` | `/assets/domains` | `AssetsClient.createDomain` | `string` | `AssetCustomDomain` | | `GET` | `/assets/domains` | `AssetsClient.listDomains` | `None` | `{ domains: AssetCustomDomain[] }` | | `POST` | `/assets/domains/{domainID}/verify` | `AssetsClient.verifyDomain` | `string` | `AssetCustomDomain` | | `DELETE` | `/assets/domains/{domainID}` | `AssetsClient.deleteDomain` | `string` | `{ deleted: boolean }` | | `GET` | `/assets/analytics` | `AssetsClient.analytics` | `None` | `AssetUsageSummary` | | `GET` | `/assets/summary` | `AssetsClient.usageSummary` | `None` | `AssetUsageSummary` | | `GET` | `/assets/events` | `AssetsClient.events` | `None` | `{ events: AssetEvent[]; total: number }` | | `POST` | `/assets/webhooks` | `AssetsClient.createWebhook` | `{ url: string; eventTypes?: string[] }` | `{ webhook: AssetWebhook; secret: string }` | | `GET` | `/assets/webhooks` | `AssetsClient.listWebhooks` | `None` | `{ webhooks: AssetWebhook[] }` | | `DELETE` | `/assets/webhooks/{webhookID}` | `AssetsClient.deleteWebhook` | `string` | `{ deleted: boolean }` | | `GET` | `/assets/webhooks/{webhookID}/deliveries` | `AssetsClient.listWebhookDeliveries` | `string` | `{ deliveries: AssetWebhookDelivery[] }` | | `POST` | `/assets/webhook-deliveries/{deliveryID}/retry` | `AssetsClient.retryWebhookDelivery` | `string` | `AssetWebhookDelivery` | | `POST` | `/assets/bulk` | `AssetsClient.bulk` | `{ action: "delete" \| "visibility" \| "add_tags"; items: { asset_id: string; revision: number; }[]; visibility?: string; tags?: string[]; idempotencyKey?: string; }` | `AssetJobSubmission` | | `GET` | `/assets/collections` | `AssetsClient.collections` | `None` | `{ collections: AssetCollection[] }` | | `POST` | `/assets/collections` | `AssetsClient.createCollection` | `{ name: string; description?: string; asset_ids?: string[]; }` | `AssetCollection` | | `PUT` | `/assets/collections/{collectionID}` | `AssetsClient.updateCollection` | `{ name: string; description?: string; asset_ids?: string[]; }` | `AssetCollection` | | `DELETE` | `/assets/collections/{collectionID}` | `AssetsClient.deleteCollection` | `string` | `{ deleted: boolean }` | | `GET` | `/assets/saved-searches` | `AssetsClient.savedSearches` | `None` | `{ saved_searches: AssetSavedSearch[] }` | | `POST` | `/assets/saved-searches` | `AssetsClient.saveSearch` | `{ name: string; filters: Record; }` | `AssetSavedSearch` | | `PUT` | `/assets/saved-searches/{searchID}` | `AssetsClient.updateSavedSearch` | `{ name: string; filters: Record; }` | `AssetSavedSearch` | | `DELETE` | `/assets/saved-searches/{searchID}` | `AssetsClient.deleteSavedSearch` | `string` | `{ deleted: boolean }` | | `GET` | `/assets/ai/config` | `AssetsClient.getAIConfig` | `None` | `AssetAIAccountConfig` | | `PUT` | `/assets/ai/config` | `AssetsClient.updateAIConfig` | `{ enabledActions: string[]; monthlySpendCapMicros: number }` | `AssetAIAccountConfig['policy']` | | `GET` | `/assets/jobs/{jobID}` | `AssetsClient.job` | `string` | `AssetJob` | | `POST` | `/assets/jobs/{jobID}/cancel` | `AssetsClient.cancelJob` | `string` | `AssetJob` | | `GET` | `/assets` | `AssetsClient.list` | `AssetListOptions` | `AssetListResult` | | `GET` | `/assets/{assetID}` | `AssetsClient.get` | `string` | `Asset` | | `POST` | `/assets/{assetID}/text-extraction` | `AssetTextClient.start` | `AssetTextExtractionInput` | `AssetTextExtraction` | | `GET` | `/assets/{assetID}/text-extraction` | `AssetTextClient.get` | `string` | `AssetTextExtraction` | | `POST` | `/assets/text-extractions/{extractionID}/retry` | `AssetTextClient.retry` | `string` | `AssetTextExtraction` | | `PATCH` | `/assets/{assetID}` | `AssetsClient.patch` | `AssetPatchInput` | `Asset` | | `GET` | `/assets/{assetID}/ai` | `AssetsClient.ai` | `string` | `AssetAIInfo` | | `POST` | `/assets/{assetID}/ai/analyze` | `AssetsClient.analyze` | `None` | `SDK response type` | | `POST` | `/assets/{assetID}/moderation` | `AssetsClient.moderate` | `None` | `SDK response type` | | `GET` | `/assets/{assetID}/transcript` | `AssetsClient.transcript` | `string` | `AssetTranscript` | | `POST` | `/assets/{assetID}/transcript` | `AssetsClient.requestTranscript` | `None` | `SDK response type` | | `POST` | `/assets/{assetID}/smart-crop` | `AssetsClient.requestSmartCrop` | `None` | `SDK response type` | | `POST` | `/assets/{assetID}/background-remove` | `AssetsClient.requestBackgroundRemoval` | `None` | `SDK response type` | | `GET` | `/assets/{assetID}/versions` | `AssetsClient.versions` | `string` | `{ versions: AssetVersion[] }` | | `POST` | `/assets/{assetID}/branches` | `AssetsClient.createBranch` | `{ name: string; fromVersionId?: string }` | `AssetVersionBranch` | | `POST` | `/assets/{assetID}/versions/{versionID}/restore` | `AssetsClient.restoreVersion` | `string` | `{ restored: boolean }` | | `POST` | `/assets/{assetID}/branches/{branch}/promote` | `AssetsClient.promoteBranch` | `string` | `{ promoted: boolean }` | | `DELETE` | `/assets/{assetID}` | `AssetsClient.delete` | `string` | `AssetJobSubmission` | | `PUT` | `/assets/{assetID}/replace` | `AssetsClient.replace` | `{ file: Blob; options?: Pick }` | `Asset` | | `POST` | `/assets/{assetID}/signed-url` | `AssetsClient.signedUrl` | `AssetSignedUrlOptions` | `AssetSignedUrl` | | `POST` | `/assets/{assetID}/transform-url` | `AssetsClient.signedTransformUrl` | `AssetSignedTransformOptions` | `AssetSignedUrl` | | `PUT` | `/assets/{assetID}/tags` | `AssetsClient.setTags` | `string` | `{ tags: string[]; revision: number }` | | `PATCH` | `/assets/{assetID}/metadata` | `AssetsClient.patchMetadata` | `Record` | `{ updated: boolean; revision: number }` | | `POST` | `/assets/{assetID}/purge` | `AssetsClient.purge` | `string` | `{ purged: boolean; asset_id: string }` | | `POST` | `/assets/widget/sessions` | `CapabilityUploadTransport.request` | `SDK request object` | `SignedSession` | | `GET` | `/assets/widget/sessions/current` | `CapabilityUploadTransport.request` | `None` | `SessionStatus` | | `PUT` | `/assets/widget/uploads/{sessionToken}/parts/{partNumber}` | `CapabilityUploadTransport.uploadPart` | `ChunkUploadSession` | `SDK response type` | | `POST` | `/assets/widget/sessions/current/complete` | `CapabilityUploadTransport.complete` | `ChunkUploadSession` | `Asset` | | `DELETE` | `/assets/widget/sessions/current` | `CapabilityUploadTransport.cancel` | `ChunkUploadSession` | `SDK response type` | | `POST` | `/assets/widget/remote-url` | `CapabilityUploadTransport.ingestUrl` | `string` | `Asset` | ## Error envelope Non-2xx responses use the StackShift response envelope. Check `success: false`, then read the structured `error` value and HTTP status. SDK clients surface the status, code, message, and details through their native error type. ## Examples These static examples show the verified route and authentication boundary. Use the official SDK method shown in each heading so serialization and response unwrapping remain consistent with the contract. ### `GET /assets/upload-sessions/{sessionID}` ```bash theme={null} curl -X GET "https://api.stackshift.cloud/api/v1/assets/upload-sessions/example-id" -H "Authorization: Bearer $STACKSHIFT_API_KEY" ``` The SDK serializes any supported query options for this operation. Response: ```json theme={null} { "success": true, "data": "example" } ``` ### `POST /assets/upload` ```bash theme={null} curl -X POST "https://api.stackshift.cloud/api/v1/assets/upload" -H "Authorization: Bearer $STACKSHIFT_API_KEY" -F 'file=@example.txt' ``` The multipart field names and additional options are owned by the SDK request type. Response: ```json theme={null} { "success": true, "data": "example" } ```