> ## 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.
# Look up the durable execution receipt for a chat turn
> Returns the current durable execution receipt for the caller's turn in the
requested scope. When no execution record exists (always the case while
fleet turn admission is disabled on the server) the answer is a normal 200
with `tracked: false` — identical whether the turn never existed or belongs
to another user. `turnAdmission` reports whether the server admits durable
turns at all; when it is `false`, clients should stop polling this route
for the session. `tracked: false` is absence, never completion.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json get /api/ai/personal/turns/by-turn/{clientTurnId}
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/personal/turns/by-turn/{clientTurnId}:
get:
tags:
- AI
summary: Look up the durable execution receipt for a chat turn
description: >
Returns the current durable execution receipt for the caller's turn in
the
requested scope. When no execution record exists (always the case while
fleet turn admission is disabled on the server) the answer is a normal
200
with `tracked: false` — identical whether the turn never existed or
belongs
to another user. `turnAdmission` reports whether the server admits
durable
turns at all; when it is `false`, clients should stop polling this route
for the session. `tracked: false` is absence, never completion.
parameters:
- in: path
name: clientTurnId
required: true
schema:
type: string
pattern: ^[A-Za-z0-9._:-]{1,64}$
- in: query
name: scope
description: >-
Current scope by default; explicit Twin scope requires active
membership.
schema:
type: string
default: current
pattern: ^(current|personal|twin:[a-f0-9]{24})$
responses:
'200':
description: >-
The execution receipt (unchanged shape), or the untracked answer
when no record exists.
content:
application/json:
schema:
oneOf:
- type: object
description: Durable execution receipt.
required:
- executionId
- turnId
- scopeKey
- revision
- state
properties:
executionId:
type: string
pattern: ^[a-f0-9]{32}$
turnId:
type: string
scopeKey:
type: string
pattern: ^(personal|twin:[a-f0-9]{24})$
revision:
type: integer
minimum: 0
state:
type: string
enum:
- accepted
- running
- stopping
- terminal
observation:
type: string
enum:
- reachable
- owner_unreachable
terminal:
type: object
nullable: true
- type: object
description: No execution record for this turn in this scope.
additionalProperties: false
required:
- success
- tracked
- turnAdmission
properties:
success:
type: boolean
enum:
- true
tracked:
type: boolean
enum:
- false
turnAdmission:
type: boolean
description: Whether this server admits durable (tracked) turns.
'400':
$ref: '#/components/responses/TurnInvalidId'
'401':
description: Authentication required.
'403':
description: Account access denied by the authenticated API boundary.
'404':
description: Inaccessible or invalid scope. Outcome remains unknown.
'503':
description: Turn control unavailable. Outcome remains unknown.
security:
- apiKeyAuth: []
- bearerAuth: []
components:
responses:
TurnInvalidId:
description: Malformed turn or history identifier.
content:
application/json:
schema:
type: object
required:
- success
- code
properties:
success:
type: boolean
enum:
- false
code:
type: string
enum:
- INVALID_TURN_ID
message:
type: string
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token passed in authorization header
````