# GovWorx API Documentation

## Docs

- [GovWorx API Policy](https://developers.govworx.ai/api-policy.md): GovWorx API Policy
- [Export Audit Log Records](https://developers.govworx.ai/api-reference/audit-log-export/export-audit-log-records.md)
- [Generate token](https://developers.govworx.ai/api-reference/authentication/generate-token.md): Use a bearer token to generate a short-lived token.
- [Allows Assist to set the active response plan for an Incident.
](https://developers.govworx.ai/api-reference/cad-integration-handler/allows-assist-to-set-the-active-response-plan-for-an-incident.md): Assist will send a valid Response Plan code for the incident. It may call this endpoint to amend the response plan in cases where it is directed to do so by a Guide Card. For example, if the situation escalates and that dictates a new or enhanced Response Plan.
- [Allows for metadata fields to be set on a CAD Incident.
](https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-metadata-fields-to-be-set-on-a-cad-incident.md): It is expected that CAD systems only accepts data for fields they support, but still return a "200 OK" response even if they don't accept some (or even all) of the fields sent.
- [Allows for sending CAD Incident Notes/Remarks.](https://developers.govworx.ai/api-reference/cad-integration-handler/allows-for-sending-cad-incident-notesremarks.md): Assist will send Notes it generates so that they can be included as part of the Incident.
- [Incident Notes](https://developers.govworx.ai/api-reference/cad-integration/incident-notes.md): Get any CAD notes the system has generated for a Call.
- [Link Incident](https://developers.govworx.ai/api-reference/cad-integration/link-incident.md): Links an incident in CAD to an active Assist call.
- [Upload Incident](https://developers.govworx.ai/api-reference/incident/upload-incident.md): Upload a new incident to the system. Token must have 'Manage Events' permission. System will only upload incident once, using the sysId to prevent duplicates. **Important**: Do NOT include the 'id' field in your request - use 'sysId' to identify incidents from your source system. By default, timesta…
- [Introduction](https://developers.govworx.ai/api-reference/introduction.md): Learn about the available GovWorx APIs
- [Get ePCRs by Event ID](https://developers.govworx.ai/api-reference/mcp-resources/get-epcrs-by-event-id.md): Fetch all ePCR records for an event. Returns the full parsed JSON for each ePCR. Token must have 'Browse Events' or 'Manage Events' permission.
- [Get Event by ID](https://developers.govworx.ai/api-reference/mcp-resources/get-event-by-id.md): Fetch a single event by ID. Token must have 'Browse Events' or 'Manage Events' permission.
- [Get Incident by ID](https://developers.govworx.ai/api-reference/mcp-resources/get-incident-by-id.md): Fetch a single incident by ID. Token must have 'Browse Events' or 'Manage Events' permission.
- [Get Media by ID](https://developers.govworx.ai/api-reference/mcp-resources/get-media-by-id.md): Fetch a single media resource by ID with signed URL and transcript (for audio). Token must have 'Browse Events' or 'Manage Events' permission.
- [List Evaluations](https://developers.govworx.ai/api-reference/quality-assurance/list-evaluations.md): Get a paginated list of QA Evaluations for a user
- [List Feedback Reports](https://developers.govworx.ai/api-reference/quality-assurance/list-feedback-reports.md): Get a paginated list of feedback reports for a user
- [CAD Vendor Guide](https://developers.govworx.ai/api-reference/realtime-cad-integration.md): Information for CAD Vendors looking to integration with GovWorx CommsCoach Assist.
- [Get Call](https://developers.govworx.ai/api-reference/realtime-calls/get-call.md): Get the current state of a call
- [Get Call Transcript Segments](https://developers.govworx.ai/api-reference/realtime-calls/get-call-transcript-segments.md): Get the transcript segments for a call
- [Get Calls](https://developers.govworx.ai/api-reference/realtime-calls/get-calls.md): Returns a paginated list of calls for this tenant
- [Pause/Unpause Audio Stream](https://developers.govworx.ai/api-reference/realtime-calls/pauseunpause-audio-stream.md): Pause or unpause playback of a live or recorded audio stream. While paused, silence is injected to keep the RTMP stream alive and the playback offset is frozen. On unpause, playback resumes from the frozen position.
- [Retrieve Call Events Registration](https://developers.govworx.ai/api-reference/realtime-calls/retrieve-call-events-registration.md): Retrieve a list of webhook registered to receive notifications about call status events.
- [Seek Live Audio Stream](https://developers.govworx.ai/api-reference/realtime-calls/seek-live-audio-stream.md): Seek to a position within the accumulated live call audio buffer. Use positionSeconds=-1 to return to live immediately. The mixer automatically returns to live when replay catches up to the buffer head.
- [Stream Call Audio](https://developers.govworx.ai/api-reference/realtime-calls/stream-call-audio.md): Stream call audio for playback. Automatically detects call status: - Active calls: Live RTMP streaming with seek support - Completed calls: Recorded audio via shared CallAudioBuffer with full seek support
- [Introduction](https://developers.govworx.ai/api-reference/realtime-introduction.md): Learn about Realtime API
- [List Phases](https://developers.govworx.ai/api-reference/train/list-phases.md): Get a list of training phases. Token must have 'Manage Phases' permission.
- [List Training Observation Reports](https://developers.govworx.ai/api-reference/train/list-training-observation-reports.md): Get a paginated list of training observation reports for a user. Token must have 'Manage Training Feedback' permission.
- [List User Phase Enrollments](https://developers.govworx.ai/api-reference/train/list-user-phase-enrollments.md): Get a list of phase enrollments for a user including the phase status. Token must have 'Manage Phases' permission.
- [List Users](https://developers.govworx.ai/api-reference/users/list-users.md): Get a list of users. Token must have 'Manage Users' permission.
- [Lookup User](https://developers.govworx.ai/api-reference/users/lookup-user.md): Fetch a single user by a unique identifier. Token must have 'Manage Users' permission.
- [Assistant Events](https://developers.govworx.ai/api-reference/webhook-handlers/assistant-events.md): Implement a handler for this webhook to get information about Assistant events during a Call (e.g., Assistant activation).
- [CAD Integration Events](https://developers.govworx.ai/api-reference/webhook-handlers/cad-integration-events.md): Implement a handler for this webhook to get information about CAD Integration events (e.g., Note Created, Case Closed, etc.).
- [Call Events](https://developers.govworx.ai/api-reference/webhook-handlers/call-events.md): Implement a handler for this webhook to get information about Call lifecycle events (e.g., started, ended, etc.).
- [Call Events Registration](https://developers.govworx.ai/api-reference/webhook-registration/call-events-registration.md): Register a webhook handler URL to receive notifications about call status events.
- [Delete Call Events Registration](https://developers.govworx.ai/api-reference/webhook-registration/delete-call-events-registration.md): Delete an existing Call Events webhook handler.
- [Update Call Events Registration](https://developers.govworx.ai/api-reference/webhook-registration/update-call-events-registration.md): Update an existing Call Events webhook handler.
- [Authorization](https://developers.govworx.ai/authorization.md): Learn how to create and use a Bearer token to authorize API requests.
- [Overview](https://developers.govworx.ai/index.md): Welcome to the GovWorx Developer Portal.
- [MCP Server](https://developers.govworx.ai/mcp-tools.md): Connect AI tools to GovWorx data using the Model Context Protocol

## OpenAPI Specs

- [api-docs](https://app.govworx.net/u/api-docs)
- [coach_openapi](https://developers.govworx.ai/api-reference/coach_openapi.json)
- [realtime_openapi](https://developers.govworx.ai/api-reference/realtime_openapi.json)

## Optional

- [About GovWorx](https://www.govworx.ai)
- [Trust Center](https://security.govworx.ai)