Agent-relevant API index

Use this page as a routing index when building agents or search-retrieval over OpenApp. Paths are relative to https://api.openapp.house/api/v1 unless noted. The machine-readable contract is OpenAPI JSON; browse schemas in the interactive API reference.

For setup and safety, start with Build an access-control agent.

Authentication and context

Concern	Operations	Notes
API keys	See API keys	Authorization: Bearer or X-API-Key
Org scope	Most GET /devices, integrations, zones	Header X-Org: {org_ulid}
Caller identity	get_me_apartments, get_me_invitations	No X-Org — Me

Physical control (entities)

Intent	HTTP	operationId
List entities	GET /entities	list_entities
Get entity	GET /entities/{id}	get_entity
Open door / gate	POST /entities/{id}/actions/switchable.open	execute_entity_action
Close / toggle	POST .../switchable.close, .../switchable.toggle	execute_entity_action

Guide: Open the door with the HTTP API.

Integrations, devices, zones

Intent	HTTP	operationId
List integrations	GET /integrations	list_integrations
Create integration	POST /integrations	create_integration
List devices	GET /devices	list_devices
Integration entities	GET /integrations/{id}/entities	list_integration_entities
Provider ops	POST /integrations/{id}/ops/{op_id}	execute_integration_op

SDK: Integrations, Devices, Entities.

Access portals and invites (admin)

Intent	HTTP	operationId
List portals	GET /integrations/{id}/access-portals	list_integration_access_portals
Create portal	POST /integrations/{id}/access-portals	create_integration_access_portal
List invites	GET /integrations/{id}/access-invites	list_integration_access_invites
Create invite	POST /integrations/{id}/access-invites	create_integration_access_invite
Update invite	PUT /integrations/{id}/access-invites/{invite_link_id}	update_integration_access_invite
Delete invite	DELETE .../access-invites/{invite_link_id}	delete_integration_access_invite

Guides: Time-bound guest invitation, Integrate existing software.

Public access (visitor / guest)

Intent	HTTP	operationId
Load invite	GET /public/access/invites/{inviteToken}	get_public_invite
Claim invite	POST .../claim	post_public_invite_claim
Execute grant (open)	POST .../execute	post_public_invite_execute
Portal config	GET /public/access/portals/{publicPortalId}	get_public_portal
Start call/video	POST .../portals/{id}/sessions	post_public_portal_sessions
Session open	POST /public/access/sessions/{sessionId}/open	post_public_session_open
Stream metadata	GET .../sessions/{sessionId}/streams	get_public_session_streams

Guide: Virtual intercom. SDK: Public Access.

Multi-tenant building

Intent	HTTP	Notes
Apartment residents	/integrations/{id}/building-users/...	Apartment residents
Org users / roles	/orgs/..., /users/...	Orgs, Users

Scripting and bulk provisioning

Intent	HTTP	operationId
Execute script	POST /scripting/execute	execute_scripting

Reference: OpenApp Scripting. Getting started: Scripting step.

Status and errors

Intent	HTTP	operationId
Backend health	GET /status	get_backend_status
Error shape	—	ApiErrorResponse (message, code, correlationId)

See Errors & retries.

Audit and compliance

Dashboard audit views cover access events for operators. For integrators, see Query access and audit activity. When automating, preserve correlationId from API errors and org policy constraints. OpenApp does not replace certified life-safety design — see Architecture guide.