Public API

Programmatically access and manage your Actian AI Analyst environment using the Public API.

The Actian AI Analyst Public API gives you programmatic access to your environment β€” without logging into the UI. Use it to build integrations, automate workflows, and connect Actian AI Analyst to your existing tooling.

Common use cases include:

  • Version-controlling your semantic layer by exporting models, metrics, glossary terms, and agents to a Git repository

  • Automating deployments using CI/CD pipelines (e.g. promote changes from dev β†’ staging β†’ production)

  • Integrating with external tools that need to read or push definitions from your environment

  • Building on top of Actian AI Analyst β€” as the API grows, you'll be able to trigger agent interactions and more directly from your own applications

What's available

Currently, the Public API covers your full Environment β€” everything that makes up your semantic layer and AI Analysts:

Resource
What it includes
Supported operations

Environment

Models, relationships, metrics, glossary terms, agents

Export (GET), Sync (PUT)

circle-info

More API resources are on the way. Coming soon: interacting with agents via API, and more ways to read and manage your environment programmatically.

Authentication

All Public API requests authenticate with an API key passed as a Bearer token in the Authorization header. API keys are scoped to your organization and are managed by admins in Studio > Settings > API Keys.

Authorization: Bearer sk_...

See API Keys for how to create and manage keys.

Base URL

Rate limits

The Public API enforces rate limiting per IP address:

Limit
Value

Max requests

2 per 5 seconds

Ban duration on violation

1 hour

Design your integrations to stay within this limit β€” exceeding it will block your IP for 1 hour.

Next steps

Last updated

Was this helpful?