The GeoRetina AI API v1 lets you drive GRAI programmatically — from your own backend, services, and automation instead of only through the chat interface. Reach for it when you want risk, exposure, conservation, reporting, or organization workflows to run as part of a server-side integration.
Base URL
Every API v1 route is served from https://app.georetina.ai/api/v1.
Endpoint schemas, request examples, and authentication details live in the
in-app API docs — treat those as the source of truth for current endpoints,
parameters, and response shapes.
What you can build
- Server-side integrations that send analysis requests and read results without a person in the loop.
- Automation and scheduled jobs that refresh risk, exposure, or monitoring outputs on a cadence.
- Organization workflows that operate inside a specific GRAI org, scoped to its data and members.
Quickstart
From zero to your first authenticated request
1 · Generate an API key
Open the API key docs and create a key for your account. Copy it once and store it in a server-side secret manager.
2 · Authenticate your request
Send the key with each request as shown in the in-app docs. Keys are tied to your account's access, so a request can only reach what that account can see.
3 · Call the base URL
Point your integration at https://app.georetina.ai/api/v1 and
follow the per-endpoint schemas in the app docs for paths and payloads.
Keep API keys server-side
Never expose API keys in browser code, public repositories, client-side environment variables, screenshots, or shared notebooks. Store them in a server-side secret manager and rotate immediately if a key may have leaked.
Choose your authentication path
API v1 has two documentation surfaces depending on whether you're integrating as an individual account or on behalf of an organization.
API key docs
Best for account-level integrations. Create and manage keys, review key-authenticated request patterns, and browse the endpoint examples available to your account.
Open API key docsOrg-scoped API docs
Best when your integration acts inside a specific GRAI organization. Gives you organization-aware examples and auth guidance at app.georetina.ai/orgs/<org-slug>/api-docs.
Finding your org route
Replace <org-slug> with your organization's slug — for
example, https://app.georetina.ai/orgs/acme-city/api-docs. The
route changes for each organization, so each team opens its own docs.
Which docs should you open?
| If you need to… | Open |
|---|---|
| Set up API keys or see key-authenticated examples | API key docs |
| Build organization-scoped integrations | app.georetina.ai/orgs/<org-slug>/api-docs |
| Send requests from your backend | app.georetina.ai/api/v1 |
Before you start
- You must be signed in to the GeoRetina AI app with the account or organization access required to view the relevant API docs.
- Organization docs are scoped by slug, so the URL differs for each organization.
- The app-hosted API docs are the source of truth for current endpoints, parameters, response schemas, and authentication requirements.