For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get API Key
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API Reference
  • Endpoint Reference
    • Organizations
    • Projects
    • Documents
    • Agent
    • Check
  • API Explorer
Get API Key
LogoLogo
On this page
  • API groups
  • Authentication
  • Response format
  • Common status codes
  • Using the interactive explorer
  • Versioning
Overview

API Reference

Complete endpoint documentation with interactive explorer
Was this page helpful?
Edit this page

Organizations

Retrieve organization details for the authenticated API key
Next
Built with

The Pyramid AI API is organized into three services, each serving a distinct purpose:

Pyramid Connect

Projects, documents, uploads, and processing.

Pyramid Agent

Chat, single queries, and batch Q&A.

Pyramid Check

Compliance verification and analysis runs.

API groups

GroupPrefixDescription
Agent/api/v2/agentSingle-shot queries and batch operations
Check/api/v2/checkCompliance verification and analysis runs
Documents/api/v2/documentsUpload, process, and manage documents
Organizations/api/v2/organizationOrganization details for the authenticated key
Projects/api/v2/projectsCreate and manage knowledge projects

Authentication

Every request (except /health) requires a Bearer token:

$curl https://api.pyramid-ai.com/api/v2/projects \
>  -H "Authorization: Bearer pai_live_YOUR_KEY"

See Authentication for key management details.

Response format

Every response follows the same envelope:

1{
2  "success": true,
3  "data": { ... },
4  "request_id": "550e8400-e29b-41d4-a716-446655440000"
5}

The request_id is also returned in the X-Request-Id header. Always include it when contacting support.

Common status codes

StatusMeaningAction
200SuccessProcess the response
201CreatedResource created successfully
204No ContentDeletion successful
400Validation ErrorFix the request body/params
401UnauthorizedCheck your API key
403ForbiddenFeature not enabled or wrong org
404Not FoundResource doesn’t exist
409ConflictDuplicate or conflicting state
429Rate LimitedWait and retry (see Retry-After header)
500Server ErrorRetry with exponential backoff

Using the interactive explorer

The endpoints below include a built-in playground. To test:

  1. Enter your API key in the Authorization field (use Bearer pai_test_* for staging)
  2. Fill in the required parameters
  3. Click Send to make a live request

The explorer sends real requests to the server you select. Use a pai_test_* key to avoid affecting production data.

Versioning

All endpoints are under /api/v2. Breaking changes will increment the version number. Non-breaking additions (new optional fields, new endpoints) are added without a version bump.