For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Get API Key

Guides API Reference

Overview
- API Reference
Endpoint Reference
API Explorer

API Reference
Organizations
Projects
Documents
Agent
Check
Export batch results as CSV
Get a batch with results
List Agent batch queries
Create an Agent batch query
Single-shot Q&A over project knowledge
Chat with the Agent over project knowledge
List requirements for a check run
Get a check run with full results
Trigger processing for a check run
List compliance check runs
Create a compliance check run
Verify a single compliance requirement
Get a presigned download URL for a document
Get a document by ID
Trigger processing for uploaded documents
List documents
Reserve a document upload slot
Delete documents by ID
List features enabled for the current API key
Health / ping
Get the organization for the current API key
Get a project by ID
Delete a project
Update a project
List Connect projects
Create a new Connect project

Get API Key

API Explorer Health

Health / ping

GET

/api/v2/health

GET

/api/v2/health

$ curl https://api.pyramid-ai.com/api/v2/health

200Retrieved

1 {
2   "status": "ok",
3   "timestamp": "2024-01-15T09:30:00Z",
4   "version": "1.0.0"
5 }

Response

OK

statusstring

timestampdatetime

versionstring

Was this page helpful?