> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Background tool jobs of a realtime session
> Polled by a realtime client while tool calls it handed to the background are
outstanding. Acks the jobs a previous note told, then returns the note for the
next turn and how many jobs are still running.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/ai/rtTools/jobs
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.159
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Audio Notes
description: Capture and ingest spoken notes into the personal vault
- name: Memory
description: User-facing memory parameters (personal + shared instance memory).
- name: My Data
description: >-
GDPR controls — personal-scope counts, async ZIP-by-email export, and
scoped soft-delete. Every endpoint pins `user = req.user._id` AND
`institution: null`; institution-scoped data is governed by the
institution's own retention policy and never reached from here.
- name: Questions
description: >-
User-facing read of the onboarding question bank used by the "create a
digital twin" wizard.
- name: Transcription
description: >-
One-shot speech-to-text for in-place dictation. Audio blob in, transcript
out — no Upload / History / RAG embeddings are persisted. Use
`/audio-notes` for anything durable.
paths:
/api/ai/rtTools/jobs:
post:
tags:
- Realtime
summary: Background tool jobs of a realtime session
description: >
Polled by a realtime client while tool calls it handed to the background
are
outstanding. Acks the jobs a previous note told, then returns the note
for the
next turn and how many jobs are still running.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RTToolJobsRequest'
responses:
'200':
description: The note, the jobs it tells and the running count
content:
application/json:
schema:
$ref: '#/components/schemas/RTToolJobsResponse'
'401':
description: Unauthorized
security:
- apiKeyAuth: []
components:
schemas:
RTToolJobsRequest:
type: object
properties:
conversationId:
type: number
description: The session-bound conversation thread, as on the exec call.
jobKey:
type: string
description: >-
The session nonce sent on the exec call, used when there is no
conversationId.
delivered:
type: array
maxItems: 20
description: >-
The jobs an injected note told, once the user's next turn after the
injection was answered. They are marked delivered for the requesting
user only.
items:
type: object
properties:
id:
type: string
status:
type: string
enum:
- done
- failed
- lost
exclude:
type: array
maxItems: 20
description: >-
Ids of jobs already injected into the session but not yet acked.
They are left out of the note and told, so they are not told twice.
Anything but a 24-hex id is ignored.
items:
type: string
pattern: ^[0-9a-f]{24}$
RTToolJobsResponse:
type: object
properties:
note:
type: string
description: >-
Text to add silently to the live session (at most 2000 characters),
empty when there is nothing to tell. The model reads it on the
user's next turn.
told:
type: array
description: >-
The finished jobs the note tells; ack them in delivered once the
user's next turn after the injection was answered.
items:
type: object
properties:
id:
type: string
status:
type: string
running:
type: integer
description: How many jobs of this conversation are still running.
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````