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
  • Getting Started
    • Introduction
    • Getting Started
    • Authentication
    • Rate Limits
    • Error Handling
  • Concepts
    • Projects & Documents
    • Document Processing
    • Knowledge & Search
    • Compliance Checking
    • Environments & Keys
    • Streaming & Async
  • How-To Guides
    • Manage Projects
    • Upload & Manage Documents
    • Query Your Knowledge Base
    • Run Compliance Checks
    • View Your Organization
Get API Key
LogoLogo
On this page
  • Before you begin
  • Get your organization
  • When to use this
  • What’s next
How-To Guides

View Your Organization

Retrieve your organization details and verify API key scope
Was this page helpful?
Edit this page
Previous
Built with

Before you begin

  • You have an API key (pai_test_* or pai_live_*)

Get your organization

Every API key is scoped to a single organization. Use this endpoint to verify which org your key belongs to:

$curl https://api-staging.pyramid-ai.com/api/v2/organization \
> -H "Authorization: Bearer pai_test_YOUR_KEY_HERE"
1{
2 "success": true,
3 "data": {
4 "id": "org_abc123",
5 "name": "Your Organization"
6 },
7 "request_id": "..."
8}

When to use this

  • Verify your key works — this is the quickest authenticated call to confirm your API key is valid and active
  • Confirm org scope — if you manage multiple organizations, use this to check which org your current key is scoped to
  • Debug authorization issues — if other endpoints return 403, check that your key’s org has the required features enabled

What’s next

  • Create a Project — start building your knowledge base
  • Authentication — learn about key rotation and environments