Openevidence Install Auth
Apps & Automationopenevidence-install-authOpenevidence Install Auth is an Agent Skill for apps & automation published in the Dicklesworthstone/pi_agent_rust repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Install and configure OpenEvidence API authentication. Use when setting up a new OpenEvidence integration, configuring API credentials, or initializing OpenEvidence in your healthcare application. Trigger with phrases like "install openevidence", "setup openevidence", "openevidence auth", "configure openevidence API key".
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/Dicklesworthstone/pi_agent_rust/blob/HEAD/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/openevidence-pack/skills/openevidence-install-auth/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/openevidence-install-auth, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
OpenEvidence Install & Auth
Overview
Set up OpenEvidence API access and configure authentication for clinical decision support queries.
Prerequisites
- Node.js 18+ or Python 3.10+
- Package manager (npm, pnpm, or pip)
- OpenEvidence Enterprise API access (contact [email protected])
- Signed BAA (Business Associate Agreement) for PHI handling
- API credentials from OpenEvidence dashboard
Instructions
Step 1: Install SDK
# Node.js
npm install @openevidence/sdk
# Python
pip install openevidence
Step 2: Configure Authentication
# Set environment variables (NEVER commit to git)
export OPENEVIDENCE_API_KEY="oe_live_***"
export OPENEVIDENCE_ORG_ID="org_***"
# Or create .env file
cat >> .env << 'EOF'
OPENEVIDENCE_API_KEY=oe_live_***
OPENEVIDENCE_ORG_ID=org_***
OPENEVIDENCE_ENVIRONMENT=production
EOF
Step 3: Add to .gitignore
# Prevent credential exposure
echo '.env' >> .gitignore
echo '.env.local' >> .gitignore
echo '.env.*.local' >> .gitignore
Step 4: Verify Connection
import { OpenEvidenceClient } from '@openevidence/sdk';
const client = new OpenEvidenceClient({
apiKey: process.env.OPENEVIDENCE_API_KEY,
orgId: process.env.OPENEVIDENCE_ORG_ID,
});
// Test connection with a simple query
async function verifyConnection() {
try {
const health = await client.health.check();
console.log('OpenEvidence connection verified:', health.status);
return true;
} catch (error) {
console.error('Connection failed:', error.message);
return false;
}
}
verifyConnection();
Output
- Installed SDK package in node_modules or site-packages
- Environment variables configured with API credentials
- .gitignore updated to prevent credential exposure
- Successful connection verification output
Error Handling
| Error | Cause | Solution |
|---|---|---|
| Invalid API Key | Incorrect or expired key | Verify key in OpenEvidence dashboard |
| Missing BAA | No signed Business Associate Agreement | Contact OpenEvidence compliance team |
| Organization Not Found | Wrong org_id | Check organization settings in dashboard |
| Network Error | Firewall blocking | Ensure outbound HTTPS to api.openevidence.com |
| Module Not Found | Installation failed | Run npm install or pip install again |
Examples
TypeScript Setup
import { OpenEvidenceClient } from '@openevidence/sdk';
const client = new OpenEvidenceClient({
apiKey: process.env.OPENEVIDENCE_API_KEY,
orgId: process.env.OPENEVIDENCE_ORG_ID,
timeout: 30000, // 30 second timeout for clinical queries
retries: 3,
});
export default client;
Python Setup
import os
from openevidence import OpenEvidenceClient
client = OpenEvidenceClient(
api_key=os.environ.get('OPENEVIDENCE_API_KEY'),
org_id=os.environ.get('OPENEVIDENCE_ORG_ID'),
timeout=30,
max_retries=3
)
Environment-Based Configuration
const environments = {
development: {
baseUrl: 'https://api.sandbox.openevidence.com',
timeout: 60000,
},
staging: {
baseUrl: 'https://api.staging.openevidence.com',
timeout: 45000,
},
production: {
baseUrl: 'https://api.openevidence.com',
timeout: 30000,
},
};
const env = process.env.NODE_ENV || 'development';
const client = new OpenEvidenceClient({
apiKey: process.env.OPENEVIDENCE_API_KEY,
...environments[env],
});
Resources
Next Steps
After successful auth, proceed to openevidence-hello-world for your first clinical query.