POST /api/internal/v1/agents/<id>/call-invite/ {channel_public_id}
This read is not paginated. It returns at most 200 rows and does not report a total, so a result of exactly 200 may be truncated.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/agents/{public_id}/call-invite/
Path parameters
Name
Type
public_id
str
Body keys (JSON)
Key
Required
Default
channel_public_id
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
POST /api/internal/v1/agents/<id>/call-leave/ {channel_public_id}
Remove the agent's voice peer from a channel call. Same grant rule as the invite (the caller must be able to use the agent); idempotent : leaving a call the agent is not in is {left: false}, not an error.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/agents/{public_id}/call-leave/
Path parameters
Name
Type
public_id
str
Body keys (JSON)
Key
Required
Default
channel_public_id
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
POST /api/internal/v1/agents/<id>/call-review/ {call_id}
The post-call review: one run over the WHOLE transcript (including everything not addressed to the agent) that creates the tasks and updates that were agreed and posts one line to the channel. Runs inline in this request: the runtime calls it from a background thread on the VM, where nothing is CPU-throttled: and once per call: a second request for the same call reports the existing status.
This read is not paginated. It returns at most 300 rows and does not report a total, so a result of exactly 300 may be truncated.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/agents/{public_id}/call-review/
Path parameters
Name
Type
public_id
str
Body keys (JSON)
Key
Required
Default
call_id
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
POST /api/internal/v1/agents/<id>/call-transcript/ {channel_public_id, started_at, ended_at, turns:[{t, who, text, kind}]}
Sent by the voice runtime when the agent leaves a call. Posts the transcript to the channel AS the agent under its call_transcript policy, and writes a memory episode so the agent remembers the call.
This read is not paginated. It returns at most 4 rows and does not report a total, so a result of exactly 4 may be truncated.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/agents/{public_id}/call-transcript/
Path parameters
Name
Type
public_id
str
Body keys (JSON)
Key
Required
Default
channel_public_id
optional or conditional
none
ended_at
optional or conditional
none
started_at
optional or conditional
none
turns
optional or conditional
none
usage
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Body: {channel_public_id, transcript, speaker_name}. The acting email header must be the INVITER (the runtime echoes it from the join order) : that is who the turn bills to.
This read is not paginated. It returns at most 300 rows and does not report a total, so a result of exactly 300 may be truncated.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/agents/{public_id}/voice-turn/
Path parameters
Name
Type
public_id
str
Query parameters
Name
Default
stream
none
Body keys (JSON)
Key
Required
Default
call_context
optional or conditional
none
channel_public_id
optional or conditional
none
participants
optional or conditional
none
prior
optional or conditional
none
speaker_name
optional or conditional
none
transcript
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
GET /api/internal/v1/call-transcripts/?channel=<public_id> [&started_at=<iso>&ended_at=<iso>][&limit=20]
Comms' fallback for linking a call card: the agent calls in this channel whose window overlaps the card's window (both bounds given), else the channel's most recent calls. Org-scoped by the caller.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/call-transcripts/
Query parameters
Name
Default
channel
none
ended_at
none
limit
none
started_at
none
Pagination
Accepts limit and offset and the server caps limit at 100. Check the response for a total or count field.
POST /api/internal/v1/calls/<channel>/floor/claim/ {agent_public_id, speaker_name, transcript, heard_at, addressed, claim_id?} -> {status: granted|wait|denied, claim_id, position, holder, prior, lease_s, reason}. Poll the same call (with claim_id) until granted or denied; a holder polling renews its lease.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/calls/{channel}/floor/claim/
Path parameters
Name
Type
channel
str
Body keys (JSON)
Key
Required
Default
addressed
optional or conditional
true
agent_public_id
optional or conditional
none
claim_id
optional or conditional
none
depth
optional or conditional
none
heard_at
optional or conditional
none
origin
optional or conditional
none
speaker_name
optional or conditional
none
transcript
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Responses
200data and meta envelope
{
"data": "..."
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
POST /api/internal/v1/calls/<channel>/floor/release/ {agent_public_id, claim_id, spoke, reply_text}
URL
Service tierhttps://agents.mattering.io/api/internal/v1/calls/{channel}/floor/release/
Path parameters
Name
Type
channel
str
Body keys (JSON)
Key
Required
Default
agent_public_id
optional or conditional
none
claim_id
optional or conditional
none
reply_text
optional or conditional
none
spoke
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
Responses
200data and meta envelope
{
"data": "..."
}
Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).
POST /api/internal/v1/voice-runtimes/heartbeat/ (secret only; no org: a runtime serves every org). Body = fleet.describe() from the runtime: {url, name, zone, version, max_calls, active_calls, draining, uptime_s}. Upserts by url.
This read is not paginated. It returns at most 80 rows and does not report a total, so a result of exactly 80 may be truncated.
URL
Service tierhttps://agents.mattering.io/api/internal/v1/voice-runtimes/heartbeat/
Body keys (JSON)
Key
Required
Default
draining
optional or conditional
none
name
optional or conditional
none
url
optional or conditional
none
version
optional or conditional
none
zone
optional or conditional
none
Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.
We use strictly necessary cookies to run this site. With your permission we also use analytics cookies
(Google Analytics and our own visit tracking) to see which pages work. Read the
Cookie notice.