How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Soracom Cloud Camera Services API

Manage Soracom Cloud Camera Services (SoraCam) devices, livestream URLs, image exports, recording exports, motion events, atomic timestamps, and dedicated cellular pack provisioning.

Soracom Cloud Camera Services API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IoT, SoraCam, Camera, and Video. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 58 operations across 39 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.

Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.

58 operations 39 paths 38 schemas 3 DELETE32 GET18 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom Cloud Camera Services API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Soracom-API-Key (api_key). An API key is passed in the header as X-Soracom-Token (api_token).

  • api_key — API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…
  • api_token — API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…

Paths & Operations 58

Across 39 paths, the API surfaces 58 operations — 3 DELETE, 32 GET, 18 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

SoraCam 58

[Soracom Cloud Camera Services](/en/guides/soracom-cloud-camera-services/)

GET
/sora_cam/devices
List SoraCam compatible camera devices.
listSoraCamDevices → 200
DELETE
/sora_cam/devices/{device_id}
Delete the SoraCam compatible camera device identified by deviceid.
handleDeleteSoraCamDevice 1 param → 200404
GET
/sora_cam/devices/{device_id}
Get the SoraCam compatible camera device information identified by deviceid.
getSoraCamDevice 1 param → 200404
GET
/sora_cam/devices/{device_id}/atom_cam/firmware/update
Retrieve firmware update information for a SoraCam compatible camera device
getSoraCamDeviceAtomCamFirmwareUpdate 1 param → 200204404
POST
/sora_cam/devices/{device_id}/atom_cam/firmware/update
Update a firmware for a SoraCam compatible camera device
updateSoraCamDeviceAtomCamFirmware 1 param → 200400404
DELETE
/sora_cam/devices/{device_id}/atom_cam/license
Unassign the license from a SoraCam compatible camera device
unassignSoraCamDeviceAtomCamLicense 1 param → 204403404
PUT
/sora_cam/devices/{device_id}/atom_cam/license
Update the assigned license for a SoraCam compatible camera device
assignSoraCamDeviceAtomCamLicense 1 param body → 200304400403404
GET
/sora_cam/devices/{device_id}/atom_cam/live_image
Get a live image from a SoraCam compatible camera device
getSoraCamDeviceAtomCamLiveImage 1 param → 200404422
GET
/sora_cam/devices/{device_id}/atom_cam/options
Retrieve enabled options for a SoraCam-compatible camera
getSoraCamDeviceAtomCamOptions 1 param → 200404
PUT
/sora_cam/devices/{device_id}/atom_cam/options/real_time_access
Enable or disable real-time access for a SoraCam-compatible camera
updateSoraCamDeviceAtomCamOptionsRealTimeAccess 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings
Retrieve the camera's various settings
getSoraCamDeviceAtomCamSettings 1 param → 200404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/logo
Retrieve the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image
getSoraCamDeviceAtomCamSettingsLogo 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/logo
Change the display settings for the ATOM tech Inc. logo shown on the bottom left of the captured image
setSoraCamDeviceAtomCamSettingsLogo 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/motion
Retrieve the settings for motion detection
getSoraCamDeviceAtomCamSettingsMotion 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/motion
Change the settings for motion
setSoraCamDeviceAtomCamSettingsMotion 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/motion_sensitivity
Retrieve the settings for motion sensitivity
getSoraCamDeviceAtomCamSettingsMotionSensitivity 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/motion_sensitivity
Change the settings for motion sensitivity
setSoraCamDeviceAtomCamSettingsMotionSensitivity 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/motion_tagging
Retrieve the display settings for motion tagging
getSoraCamDeviceAtomCamSettingsMotionTagging 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/motion_tagging
Change the display settings for motion tagging
setSoraCamDeviceAtomCamSettingsMotionTagging 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/night_vision
Retrieve the settings for night vision mode
getSoraCamDeviceAtomCamSettingsNightVision 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/night_vision
Change the settings for night vision mode
setSoraCamDeviceAtomCamSettingsNightVision 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/quality
Retrieve the quality settings
getSoraCamDeviceAtomCamSettingsQuality 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/quality
Change the quality settings
setSoraCamDeviceAtomCamSettingsQuality 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/rotation
Retrieve the settings for rotating the image by 180 degrees
getSoraCamDeviceAtomCamSettingsRotation 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/rotation
Change the settings for rotating the image by 180 degrees
setSoraCamDeviceAtomCamSettingsRotation 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/sound
Retrieve the settings for sound detection
getSoraCamDeviceAtomCamSettingsSound 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/sound
Change the settings for sound detection
setSoraCamDeviceAtomCamSettingsSound 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/sound_sensitivity
Retrieve the settings for sound sensitivity
getSoraCamDeviceAtomCamSettingsSoundSensitivity 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/sound_sensitivity
Change the settings for sound sensitivity
setSoraCamDeviceAtomCamSettingsSoundSensitivity 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/status_light
Retrieve the settings for the status light (indicator light that shows the status of the camera)
getSoraCamDeviceAtomCamSettingsStatusLight 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/status_light
Change the settings for the status light (indicator light that shows the status of the camera)
setSoraCamDeviceAtomCamSettingsStatusLight 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/atom_cam/settings/timestamp
Retrieve the display settings for the timestamp shown on the bottom right of the captured image
getSoraCamDeviceAtomCamSettingsTimestamp 1 param → 200404
POST
/sora_cam/devices/{device_id}/atom_cam/settings/timestamp
Change the display settings for the timestamp shown on the bottom right of the captured image
setSoraCamDeviceAtomCamSettingsTimestamp 1 param body → 200400404
POST
/sora_cam/devices/{device_id}/data
Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device
createSoraCamDeviceDataEntry 2 params body → 201404
PUT
/sora_cam/devices/{device_id}/data/{time}
Save arbitrary data to Harvest Data linked to a SoraCam compatible camera device and timestamp
updateSoraCamDeviceDataEntry 3 params body → 200404
GET
/sora_cam/devices/{device_id}/events
List SoraCam events for the specified device.
listSoraCamDeviceEventsForDevice 6 params → 200400404
GET
/sora_cam/devices/{device_id}/exports/usage
Get the remaining number of still images that can be exported and the remaining exportable time of recorded video.
getSoraCamDeviceExportUsage 1 param → 200404
DELETE
/sora_cam/devices/{device_id}/exports/usage/limit_override
Reset the monthly limit on the recorded video time available for export for SoraCam compatible camera device to the default value.
deleteSoraCamDeviceExportUsageLimitOverride 1 param → 204404
PUT
/sora_cam/devices/{device_id}/exports/usage/limit_override
Set the monthly limit on the recorded video time available for export for SoraCam compatible camera device.
updateSoraCamDeviceExportUsageLimitOverride 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/images/exports
Get a list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device.
listSoraCamDeviceImageExportsForDevice 4 params → 200404
POST
/sora_cam/devices/{device_id}/images/exports
Start the process of exporting still images from recorded video saved on the cloud
exportSoraCamDeviceRecordedImage 1 param body → 200400403404
GET
/sora_cam/devices/{device_id}/images/exports/{export_id}
Get the current status of the process of exporting still images from recorded video taken with a SoraCam compatible camera device
getSoraCamDeviceExportedImage 2 params → 200404
GET
/sora_cam/devices/{device_id}/name
Get the current name of the SoraCam compatible camera device.
getSoraCamDeviceName 1 param → 200404
POST
/sora_cam/devices/{device_id}/name
Changes the name of the SoraCam compatible camera device.
setSoraCamDeviceName 1 param body → 200400404
GET
/sora_cam/devices/{device_id}/power_state
Get the current power state of the SoraCam compatible camera device.
getSoraCamDevicePowerState 1 param → 200404
POST
/sora_cam/devices/{device_id}/power_state
Changes the power state of the SoraCam compatible camera device.
setSoraCamDevicePowerState 1 param body → 200400404
POST
/sora_cam/devices/{device_id}/reboot
Reboot the SoraCam compatible camera device.
rebootSoraCamDevice 1 param → 200404
GET
/sora_cam/devices/{device_id}/recordings_and_events
Retrieve a list of recording periods and events for a SoraCam compatible camera device
listSoraCamDeviceRecordingsAndEvents 5 params → 200400404
GET
/sora_cam/devices/{device_id}/stream
Get information for streaming recorded video from the cloud.
getSoraCamDeviceStreamingVideo 3 params → 200400404
GET
/sora_cam/devices/{device_id}/videos/exports
Get a list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device.
listSoraCamDeviceVideoExportsForDevice 4 params → 200404
POST
/sora_cam/devices/{device_id}/videos/exports
Start the process of exporting recorded video saved on the cloud
exportSoraCamDeviceRecordedVideo 1 param body → 200400403404
GET
/sora_cam/devices/{device_id}/videos/exports/{export_id}
Get the current status of the process of exporting recorded video taken with a SoraCam compatible camera device
getSoraCamDeviceExportedVideo 2 params → 200404
GET
/sora_cam/devices/atom_cam/firmware/updates
Retrieve a list of SoraCam compatible camera devices that can update the firmware
listSoraCamDeviceAtomCamFirmwareUpdates → 200
GET
/sora_cam/devices/events
List SoraCam events.
listSoraCamDeviceEvents 6 params → 200400
GET
/sora_cam/devices/images/exports
Get a list of the current status of the process of exporting still image from recorded video taken with a SoraCam compatible camera device.
listSoraCamDeviceImageExports 4 params → 200404
GET
/sora_cam/devices/videos/exports
Get a list of the current status of the process of exporting recorded video taken with a SoraCam compatible camera device.
listSoraCamDeviceVideoExports 4 params → 200404
GET
/sora_cam/license_packs
List license packs of Soracom Cloud Camera Services
listSoraCamLicensePacks → 200400
PUT
/sora_cam/license_packs/{license_pack_id}/quantity
Update the license quantity of Soracom Cloud Camera Services
updateSoraCamLicensePackQuantity 1 param body → 204400

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are SoraCamDevice (11 properties), SoraCamAtomCamSettingsAll (11 properties), SoraCamVideoExportInfo (7 properties), SoraCamImageExportInfo (7 properties). Each schema is shown below with its type and property counts.

SoraCamAtomCamSettingsLogo
object
1 property 1 required
SoraCamImageExportInfo
object
7 properties 5 required
SoraCamDeviceRealTimeAccessOption
object
1 property 1 required
SoraCamVideoExportSpecification
object
5 properties 2 required
SoraCamExportImageToHarvestFiles
object
Specifies the settings for exporting images to Harvest Files. Example: harvestFiles: { pathPrefix: "/soracam/{deviceid}" } If the pathPrefix is omitted or set…
1 property
SoraCamAtomCamSettingsStatusLight
object
1 property 1 required
SoraCamEvent
object
5 properties 4 required
SoraCamExportUsageLimitOverrideSpecification
object
1 property 1 required
SoraCamAtomCamSettingsRotation
object
1 property 1 required
SoraCamAtomCamSettingsMotion
object
1 property 1 required
SoraCamDeviceOptions
object
1 property 1 required
SoraCamImageExportSpecification
object
3 properties 1 required
SoraCamDeviceLicenseUpdate
object
1 property
SoraCamExportVideoToHarvestFiles
object
Specifies the settings for exporting video to Harvest Files. Example: harvestFiles: { pathPrefix: "/soracam/{deviceid}" } If the pathPrefix is omitted or set t…
1 property
SoraCamRecordingsAndEventsList
object
2 properties 2 required
SoraCamDevicesFirmwareUpdate
object
3 properties 3 required
SoraCamLicensePackResponse
object
5 properties
SoraCamPowerState
object
1 property 1 required
SoraCamAtomCamSettingsMotionTagging
object
1 property 1 required
SoraCamAtomCamSettingsSound
object
1 property 1 required
SoraCamImageExportUsage
object
4 properties 4 required
SoraCamAtomCamSettingsMotionSensitivity
object
1 property 1 required
SoraCamStreamingVideo
object
2 properties 1 required
SoraCamAtomCamSettingsTimestamp
object
1 property 1 required
SoraCamAtomCamLiveImageResponse
object
1 property 1 required
SoraCamExportUsage
object
4 properties 4 required
SoraCamAtomCamSettingsQuality
object
1 property 1 required
SoraCamLicensePackQuantityUpdatingRequest
object
2 properties
SoraCamPlayListEntry
object
3 properties 1 required
SoraCamAtomCamSettingsNightVision
object
1 property 1 required
SoraCamDeviceConfiguration
object
Configuration of the SoraCam compatible camera device.
3 properties
SoraCamVideoExportUsage
object
4 properties 4 required
SoraCamAtomCamSettingsAll
object
11 properties 10 required
SoraCamVideoExportInfo
object
7 properties 5 required
SoraCamAtomCamSettingsSoundSensitivity
object
1 property 1 required
SoraCamDeviceName
object
1 property 1 required
SoraCamDeviceLicenseInfo
object
2 properties 2 required
SoraCamDevice
object
11 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-soracam-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
Soracom Group Configuration API
Soracom Billing API
Soracom Stats and Diagnostics API
Soracom Auth and Access Management API
Soracom Lagoon API
Soracom Batch API
Soracom Analysis API
Soracom API Sandbox: Coupon API
Soracom API Sandbox: Operator API
Soracom API Sandbox: Order API
Soracom API Sandbox: Stats API
Where this information came from

This is an independent, third-party profile of Soracom Cloud Camera Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.