POST
/v1/viewer-url/urlFile URL API
Creates a Viewer-accessible Signed URL based on the file URL provided by the client. The file must be hosted on an external server and accessible for download via the provided URL. Custom headers can be provided if required to access the URL.
Headers
| Field Name | Type | Required | Description |
|---|---|---|---|
| x-client-id | string | Required | Client ID |
| x-api-key | string | Required | API Key |
| Content-Type | string | Required | Request Body |
Request Bodyapplication/json
| Field Name | Type | Required | Description |
|---|---|---|---|
| userId | string | Optional | User ID |
| fileInfo | object | Required | File metadata (JSON object) |
| planCode | string | Optional | Plan code |
fileInfoJSON
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Unique file ID |
| name | string | Required | File name |
| url | string | Required | File download URL |
| urlHeaders | object | Optional | Headers required to access the URL |
| Status | Description | Error Code | Message | Response |
|---|---|---|---|---|
| 200 | File processed successfully | - | - | |
| 400 | Invalid Client | VIEWER_URL_INVALID_CLIENT | Invalid client | |
| 400 | Missing Credentials | VIEWER_URL_INVALID_API_KEY | Invalid client-id or api-key | |
| 400 | Validation Error | VIEWER_URL_VALIDATION_ERROR | fileInfo: name should not be empty... | |
| 400 | Plan Not Exists | VIEWER_URL_CLIENT_PLAN_NOT_EXISTS | The webcad client plan not exists |