The Platform API contains tenant level configuration and settings used throughout Rhythm. This includes Saved Queries, Custom Fields, and Forms.
Platform
/- Retrieves a previously uploaded file
Uploads a file to a temporary staging location
Gets a presigned URL to update for uploading a public image
Returns an AWS S3 pre-signed URL for use in downloading a file from a web application
Returns an AWS S3 pre-signed URL for use in uploading a file from a web application
Retrieves a previously uploaded file
Retrieves a previously uploaded file
Retrieves a previously up...
Platform (v1-2025-04-18)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1
https://platform.api.rhythmsoftware.com
- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/staging/{tenantId}/{service}/{filename}
- https://platform.api.rhythmsoftware.com/fileUploads/staging/{tenantId}/{service}/{filename}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/staging/{tenantId}/{service}/{filename}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: string'- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/image
- https://platform.api.rhythmsoftware.com/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/image
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/image'- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/presignedUrlForUpload
- https://platform.api.rhythmsoftware.com/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/presignedUrlForUpload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/presignedUrlForUpload?isPublic=true&contentType=string'Request
This method contacts S3 and generates a "presigned URL." This URL can be used to post a file. The return value is the URL to post.
Security
knox-authorizer
- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/signedUrl/{service}/{id}/{fileid}
- https://platform.api.rhythmsoftware.com/fileUploads/{tenantId}/signedUrl/{service}/{id}/{fileid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/signedUrl/{service}/{id}/{fileid}?filename=string&expires=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
"string"
Request
This method contacts S3 and generates a "presigned URL." This URL can be used to post a file. The return value is the URL to post.
Security
knox-authorizer
- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/signedUrlRequest/{service}/{filename}
- https://platform.api.rhythmsoftware.com/fileUploads/{tenantId}/signedUrlRequest/{service}/{filename}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/signedUrlRequest/{service}/{filename}?contentType=string&public=true' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "download_url": "string", "signed_url": "string", "url": "string" }
- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/{service}/{id}/{fileid}
- https://platform.api.rhythmsoftware.com/fileUploads/{tenantId}/{service}/{id}/{fileid}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/{service}/{id}/{fileid}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/{service}/{id}/{fileid}/image
- https://platform.api.rhythmsoftware.com/fileUploads/{tenantId}/{service}/{id}/{fileid}/image
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/{service}/{id}/{fileid}/image' \
-H 'access_token: YOUR_API_KEY_HERE'