curl --request POST \
--url https://api.periskope.app/v1/media/migrate-url/batch \
--header 'Authorization: Bearer <api_key>' \
--header 'Content-Type: application/json' \
--data '{
"urls": [
"https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5/919876543210/msg_ABCDEF123/file.jpg",
"https://storage.googleapis.com/periskope-attachments/other-org-id/919876543210/msg_XYZ789/file-2.pdf"
],
"access": "private",
"expires_in_seconds": 86400
}'
{
"results": [
{
"index": 0,
"success": true,
"url": "https://api.periskope.app/app/media/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919876543210%2Fmsg_ABCDEF123%2Ffile.jpg?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
},
{
"index": 1,
"success": false,
"error": "URL belongs to a different organization"
}
],
"migrated_count": 1,
"failed_count": 1,
"access": "private",
"expires_in_seconds": 86400
}
Media APIs
Migrate Media URLs (Batch)
Convert up to 1000 legacy Google Cloud Storage media URLs to the new Periskope media URL format in a single request
curl --request POST \
--url https://api.periskope.app/v1/media/migrate-url/batch \
--header 'Authorization: Bearer <api_key>' \
--header 'Content-Type: application/json' \
--data '{
"urls": [
"https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5/919876543210/msg_ABCDEF123/file.jpg",
"https://storage.googleapis.com/periskope-attachments/other-org-id/919876543210/msg_XYZ789/file-2.pdf"
],
"access": "private",
"expires_in_seconds": 86400
}'
{
"results": [
{
"index": 0,
"success": true,
"url": "https://api.periskope.app/app/media/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919876543210%2Fmsg_ABCDEF123%2Ffile.jpg?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
},
{
"index": 1,
"success": false,
"error": "URL belongs to a different organization"
}
],
"migrated_count": 1,
"failed_count": 1,
"access": "private",
"expires_in_seconds": 86400
}
This endpoint converts up to 1000 legacy
storage.googleapis.com attachment URLs (or existing Periskope media URLs) to the new Periskope media URL format in a single request.
Each URL succeeds or fails independently — results[i] in the response corresponds to urls[i] in the request, so one invalid URL does not fail the whole batch.
All media files must belong to the organization of the API key used. URLs from other organizations or non-Periskope buckets fail individually with an
error in their result entry.Headers
string
required
Bearer token with your API key e.g.
Bearer <api_key>Body
string[]
required
The media URLs to migrate. Maximum
1000 URLs per request.string
Access mode for the returned URLs. One of
private or public.private— returns tokenized links that expirepublic— returns bare links without a token
number
Validity of the returned links in seconds. Only valid for private links — returns an error if passed for public links. Clamped between
60 (1 minute) and 604800 (7 days). Defaults to your organization’s configured link expiry (24 hours unless changed). A single token is minted and shared across all URLs in the batch.Response
object[]
One result per input URL, in the same order as the request.
number
Number of URLs migrated successfully.
number
Number of URLs that failed to migrate.
string
The access mode applied to the returned URLs —
private or public.number
Validity of the returned links in seconds. Only present for private links.
curl --request POST \
--url https://api.periskope.app/v1/media/migrate-url/batch \
--header 'Authorization: Bearer <api_key>' \
--header 'Content-Type: application/json' \
--data '{
"urls": [
"https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5/919876543210/msg_ABCDEF123/file.jpg",
"https://storage.googleapis.com/periskope-attachments/other-org-id/919876543210/msg_XYZ789/file-2.pdf"
],
"access": "private",
"expires_in_seconds": 86400
}'
{
"results": [
{
"index": 0,
"success": true,
"url": "https://api.periskope.app/app/media/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919876543210%2Fmsg_ABCDEF123%2Ffile.jpg?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
},
{
"index": 1,
"success": false,
"error": "URL belongs to a different organization"
}
],
"migrated_count": 1,
"failed_count": 1,
"access": "private",
"expires_in_seconds": 86400
}
Was this page helpful?