Coram Ai Locations API
Manage physical site configurations where cameras and NVRs are deployed. Locations represent your facilities, buildings, or areas. Use these endpoints to create, update, list, and delete locations.
Manage physical site configurations where cameras and NVRs are deployed. Locations represent your facilities, buildings, or areas. Use these endpoints to create, update, list, and delete locations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/coram-ai:coram-ai-locations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Coram Locations API
description: '# Introduction
The Coram API enables seamless programmatic access to your security camera infrastructure, allowing you to build custom integrations and automate workflows. # Supported Actions
Manage and interact with your Coram platform resources:
| Resource | Description |
| -------- | ----------- |
| **Camera Groups** | Organize and configure camera collections |
| **Cameras** | Access camera settings, streams, and metadata |
| **Locations** | Manage physical site configurations |
| **NVRs** | Control and monitor network video recorders |
| **Access Control** | Manage doors, cards, and permissions |
## Access Control
Card and permission changes are saved before they reach controllers. If a request fails, check the saved state before retrying. # Required Headers
Every API request must include the following headers:
| Header | Required | Description |
| ------ | -------- | ----------- |
| `X-Auth-Token` | Yes | Your API key (from the API key List Page) |
**Example:**
```
curl -X GET "https://api.coram.ai/developer-api/v1/cameras" \
-H "X-Auth-Token: xxxxxxxxxxxxxxx"
```
# Response Format
All API responses follow a consistent structure based on the operation result. ## Success Response
**List Operations** (e.g., `GET /v1/cameras`)
Returns a `results` array with pagination support:
```json
{
"results": [
{ "id": "cam_001", "name": "Front Door", ... },
{ "id": "cam_002", "name": "Lobby", ... }
],
"has_more": true
}
```
When `has_more` is `true`, additional results are available. Use pagination parameters to fetch more. **Bulk/Batch Operations** (e.g., `POST /v1/cameras`, `PATCH /v1/cameras`)
Returns a top-level `status` field indicating whether the API request was processed, and a `results` array where each item reflects the outcome of an individual operation:
```json
{
"status": "success",
"results": [
{ "status": "success", "data": { "id": "cam_001", "mac_address": "..." } },
{ "status": "error", "error": { "code": "VALIDATION_ERROR", "message": "..." } }
]
}
```
| Field | Description |
| ----- | ----------- |
| `status` (top-level) | `"success"` if the request was processed |
| `results[].status` | `"success"` or `"error"` for each operation |
| `results[].data` | Present when `status` is `"success"` |
| `results[].error` | Present when `status` is `"error"` |
## Error Response
When an error occurs, the response includes `status` set to `"error"` along with detailed error information:
```json
{
"status": "error",
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid MAC address format",
"field": "mac_address"
}
}
```
**Error Fields:**
| Field | Type | Description |
| ----- | ---- | ----------- |
| `code` | string | Machine-readable error code |
| `message` | string | Human-readable error description |
| `field` | string | The field that caused the error (if applicable) |
# HTTP Status Codes
The API uses standard HTTP status codes to indicate the success or failure of requests:
## Success Codes
| Code | Description |
| ---- | ----------- |
| `200 OK` | Request succeeded |
| `201 Created` | Resource successfully created |
| `204 No Content` | Request succeeded with no response body |
## Client Error Codes
| Code | Description |
| ---- | ----------- |
| `400 Bad Request` | Invalid request syntax or parameters |
| `401 Unauthorized` | Missing or invalid API key |
| `403 Forbidden` | Valid API key but insufficient permissions |
| `404 Not Found` | Requested resource does not exist |
| `422 Unprocessable Entity` | Validation error in request body |
| `429 Too Many Requests` | Rate limit exceeded |
## Server Error Codes
| Code | Description |
| ---- | ----------- |
| `500 Internal Server Error` | Unexpected server error (rare) |
| `502 Bad Gateway` | Upstream service unavailable |
| `503 Service Unavailable` | Service temporarily unavailable |
# Error Handling Best Practices
1. **Always check the `status` field** — Verify if the response indicates `"success"` or `"error"`
2.'
version: 1.0.0
servers:
- url: https://developer.coram.ai
description: Production
security:
- X-Auth-Token: []
tags:
- name: Locations
description: Manage physical site configurations where cameras and NVRs are deployed. Locations represent your facilities, buildings, or areas. Use these endpoints to create, update, list, and delete locations.
paths:
/v1/locations:
get:
tags:
- Locations
summary: List locations
description: 'List all locations accessible to the user.
Retrieve locations accessible to the user for the organization.
Returns locations across all product lines the user has access to.'
operationId: list_locations
parameters:
- required: false
schema:
type: integer
minimum: 1.0
title: page
default: 1
name: page
in: query
- required: false
schema:
type: integer
maximum: 100.0
minimum: 1.0
title: limit
default: 100
name: limit
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LocationList'
'403':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-public-api: true
x-public-api-version: v1
security:
- X-Auth-Token: []
post:
tags:
- Locations
summary: Create locations
description: 'Create multiple locations in bulk.
Create one or more locations for the organization.'
operationId: create_locations
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CreateLocationPayload'
type: array
title: CreateLocationPayload
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLocationResponse'
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- X-Auth-Token: []
x-public-api: true
x-public-api-version: v1
parameters: []
components:
schemas:
ErrorDetails:
properties:
code:
allOf:
- $ref: '#/components/schemas/ErrorCode'
description: Error code
message:
type: string
title: Message
description: Error message
field:
type: string
title: Field
description: Error field
docs:
type: string
title: Docs
description: Error docs
type: object
required:
- code
- message
title: ErrorDetails
description: Error message
CreateLocationPayload:
properties:
name:
type: string
maxLength: 30
minLength: 1
title: name
description: Display name for the location (max 30 characters)
address:
type: string
minLength: 5
title: address
description: Physical street address (min 5 characters)
timezone:
type: string
title: timezone
description: Timezone (IANA format, e.g., 'America/New_York')
type: object
required:
- name
- address
title: CreateLocationPayload
description: Request model for creating a location.
x-public-api-group: locations
CreateLocationSuccessData:
properties:
id:
type: integer
title: id
description: Unique identifier of the created location
type: object
required:
- id
title: CreateLocationSuccessData
description: Data returned for a successfully created location.
x-public-api-group: locations
CreateLocationSuccessResult:
properties:
status:
type: string
enum:
- success
title: Status
default: success
data:
allOf:
- $ref: '#/components/schemas/CreateLocationSuccessData'
title: CreateLocationSuccessData
description: Success data
type: object
required:
- data
title: CreateLocationSuccessResult
description: Success result for location creation.
x-public-api-group: locations
Summary:
properties:
total:
type: integer
title: Total
description: Total number of operations in request
success_count:
type: integer
minimum: 0.0
title: Success Count
description: Number of successful operations
failure_count:
type: integer
minimum: 0.0
title: Failure Count
description: Number of failed operations
type: object
required:
- total
- success_count
- failure_count
title: Summary
description: Summary of operation.
Location:
properties:
id:
type: integer
title: Id
description: Unique location identifier
name:
type: string
title: Name
description: Location display name
address:
type: string
title: Address
description: Physical street address
timezone:
type: string
title: Timezone
description: Timezone (IANA format, e.g., 'America/New_York')
type: object
required:
- id
- name
- address
title: Location
description: A physical location where cameras and NVRs are installed.
x-public-api-group: locations
ErrorResponse:
properties:
status:
type: string
enum:
- error
title: Status
default: error
error:
allOf:
- $ref: '#/components/schemas/ErrorDetails'
title: Error
description: Error details
type: object
required:
- error
title: ErrorResponse
description: Error response model.
CreateLocationErrorResult:
properties:
status:
type: string
enum:
- error
title: Status
default: error
error:
allOf:
- $ref: '#/components/schemas/ErrorDetails'
title: ErrorDetails
description: Error details
type: object
required:
- error
title: CreateLocationErrorResult
description: Error result for location creation.
x-public-api-group: locations
ErrorCode:
type: string
enum:
- VALIDATION_ERROR
- BATCH_SIZE_EXCEEDED
- NO_CAMERAS_PROVIDED
- PARTIAL_OPERATIONS_NOT_SUPPORTED
- CAMERA_ALREADY_EXISTS
- CAMERA_NOT_FOUND
- NO_LICENSES_AVAILABLE
- INVALID_MAC_ADDRESS
- INVALID_IP_ADDRESS
- DUPLICATE_MAC_ADDRESSES
- NVR_CAPACITY_EXCEEDED
- NVR_NOT_FOUND
- INVALID_NVR_NAME
- LOCATION_NOT_FOUND
- NVR_REGISTRATION_FAILED
- NVR_ALREADY_REGISTERED
- PING_REQUEST_TIMEOUT
- PING_REQUEST_FAILED
- SPEEDTEST_REQUEST_TIMEOUT
- SPEEDTEST_REQUEST_FAILED
- NO_NVRS_PROVIDED
- DUPLICATE_NVR_NAMES
- LOCATION_ACCESS_DENIED
- LOCATION_NAME_ALREADY_EXISTS
- LOCATION_CREATION_FAILED
- NO_LOCATIONS_PROVIDED
- DUPLICATE_LOCATION_NAMES
- ALERT_EVENT_NOT_FOUND
- ALERT_NO_VIDEO_AVAILABLE
- ALERT_CAMERA_NOT_FOUND
- ALERT_CLIP_GENERATION_FAILED
- ALERT_NOT_FIREARM
- FIREARM_ALERT_NOT_FOUND
- INVALID_RECIPIENT_EMAILS
- PREMIUM_ALERT_CAMERA_LIMIT_EXCEEDED
- CAMERA_ALREADY_IN_USE
- ACCESS_EVENT_NOT_FOUND
- ACCESS_EVENT_NO_VIDEO_AVAILABLE
- ACCESS_EVENT_CLIP_GENERATION_FAILED
- CAMERA_GROUP_NOT_FOUND
- CAMERA_GROUP_NAME_ALREADY_EXISTS
- CAMERA_GROUP_CREATION_FAILED
- NO_GROUPS_PROVIDED
- DUPLICATE_GROUP_NAMES
- INVALID_GROUP_ID
- DUPLICATE_GROUP_IDS
title: ErrorCode
description: Centralized error codes for Developer API endpoints.
CreateLocationResponse:
properties:
status:
type: string
enum:
- success
title: Status
default: success
summary:
allOf:
- $ref: '#/components/schemas/Summary'
title: Summary
description: Summary of the creation operation
results:
items:
oneOf:
- $ref: '#/components/schemas/CreateLocationSuccessResult'
- $ref: '#/components/schemas/CreateLocationErrorResult'
discriminator:
propertyName: status
mapping:
success: '#/components/schemas/CreateLocationSuccessResult'
error: '#/components/schemas/CreateLocationErrorResult'
type: array
title: CreateLocationResult
description: List of location creation results
type: object
required:
- summary
title: CreateLocationResponse
description: Response model for bulk location creation.
x-public-api-group: locations
LocationList:
properties:
results:
items:
$ref: '#/components/schemas/Location'
type: array
title: Location
description: List of locations
has_more:
type: boolean
title: Has More
description: True if additional pages are available
type: object
required:
- results
- has_more
title: LocationList
description: Paginated list of locations.
x-public-api-group: locations
securitySchemes:
X-Auth-Token:
type: apiKey
in: header
name: X-Auth-Token
x-tagGroups:
- name: Surveillance
tags:
- cameras
- camera-groups
- locations
- nvrs
- alerts
- name: Access Control
tags:
- doors
- credentials
- events
- permissions
- name: Emergency Management System
tags:
- reunification
x-provenance:
method: harvested
publisher: Coram Ai
source: https://developer.coram.ai/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)