> ## 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.
# Queue an async full-dataset CSV export
> Queues a background CSV export for the specified admin resource. The export
worker leases the job, applies the same role-scoped filter as the list
endpoint (so a non-super admin only exports their managed accounts), builds
the CSV, saves it to the requesting admin's private vault, and emails a
download link when ready.
Filters and columnIds from the request body narrow the result but never
widen the caller's authorized scope.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/exports
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
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: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/exports:
post:
tags:
- Exports
summary: Queue an async full-dataset CSV export
description: >
Queues a background CSV export for the specified admin resource. The
export
worker leases the job, applies the same role-scoped filter as the list
endpoint (so a non-super admin only exports their managed accounts),
builds
the CSV, saves it to the requesting admin's private vault, and emails a
download link when ready.
Filters and columnIds from the request body narrow the result but never
widen the caller's authorized scope.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExportRequest'
responses:
'202':
description: >-
Export job queued successfully. A download link will be emailed when
ready.
content:
application/json:
schema:
$ref: '#/components/schemas/ExportQueuedResponse'
'400':
description: Invalid request — unknown resource or malformed body.
content:
application/json:
schema:
$ref: '#/components/schemas/ExportErrorResponse'
'401':
description: Unauthorized — missing or invalid JWT.
security:
- bearerAuth: []
components:
schemas:
ExportRequest:
type: object
required:
- resource
properties:
resource:
type: string
description: >-
Export registry key identifying the dataset to export (e.g.
'accounts').
example: accounts
filters:
type: object
description: >-
Opaque per-resource filter payload (same shape as the list endpoint
body). The worker re-applies role-scoped authorization on top of
these filters — they can only narrow, never widen, the caller's
scope.
example:
activeOnly: true
accountsearch: acme
columnIds:
type: array
items:
type: string
description: >-
Ordered list of column ids to include in the CSV (from the
resource's registry column definitions). Unknown ids are silently
ignored. Capped at 200.
example:
- name
- status
- managerEmail
- credits
ExportQueuedResponse:
type: object
properties:
success:
type: boolean
example: true
jobId:
type: string
description: Mongo ObjectId of the queued dataExportJob document.
example: 6671abc1234def5678901234
message:
type: string
description: Human-readable confirmation that the export is being prepared.
example: >-
Your export is being prepared. We will email you a download link
when it is ready.
ExportErrorResponse:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Unknown export resource
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token passed in authorization header
````