> ## 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.
# Connect this Digital Twin to Procore (read-only)
> Validates the Client ID and Client Secret of a Procore app (a Developer Managed Service Account installed by a Procore company admin) by signing in to Procore, listing the companies the app is installed in and counting its permitted projects. On success the pair is stored encrypted and the twin's Procore tool is switched on. When the app is installed in more than one company the response asks for one (`needsCompany`); send the same body again with `company_id`. Instance administrators only; at most 5 attempts per 10 minutes per twin. Nothing is ever written to Procore.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json post /api/user/agents/connect/procore/key
openapi: 3.0.0
info:
title: Pria Runtime API
version: 2.0.183
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/user/agents/connect/procore/key:
post:
tags:
- Procore connection
summary: Connect this Digital Twin to Procore (read-only)
description: >
Validates the Client ID and Client Secret of a Procore app (a Developer
Managed Service Account installed by a Procore company admin) by signing
in to Procore, listing the companies the app is installed in and
counting its permitted projects. On success the pair is stored encrypted
and the twin's Procore tool is switched on. When the app is installed in
more than one company the response asks for one (`needsCompany`); send
the same body again with `company_id`. Instance administrators only; at
most 5 attempts per 10 minutes per twin. Nothing is ever written to
Procore.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- client_id
- client_secret
properties:
client_id:
type: string
client_secret:
type: string
format: password
environment:
type: string
enum:
- production
- sandbox
default: production
company_id:
type: string
description: Only when a previous call returned needsCompany
responses:
'200':
description: Connected, or a company must be chosen
content:
application/json:
schema:
oneOf:
- type: object
properties:
success:
type: boolean
example: true
connected:
type: boolean
example: true
companyId:
type: string
example: '123456'
companyName:
type: string
projectCount:
type: integer
example: 5
- type: object
properties:
success:
type: boolean
example: true
connected:
type: boolean
example: false
needsCompany:
type: boolean
example: true
companies:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
'400':
description: >-
Missing or rejected credentials (MISSING_CREDENTIALS,
INVALID_CREDENTIALS, NOT_INSTALLED, INVALID_ENVIRONMENT,
INVALID_COMPANY, FORBIDDEN)
'403':
description: Not an instance administrator of this twin
'429':
description: Too many connection attempts
'502':
description: Procore could not be reached
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````