Quick Start

Make your first GoSmarter API call in under 2 minutes using an API key.

Prerequisites

• A GoSmarter account with access to at least one company
• Access to this developer portal (you're here)

Step 1: Create an API key

Log in to this portal → My Account → API Keys → Create key.

Copy the key value — it is only shown once.

Code
export GOSMARTER_API_KEY=zpka_your_key_here

Step 2: Find your company ID

Your company ID is required for most API calls. Fetch the list of companies your account has access to:

Code
curl --request POST "https://api.gosmarter.ai/api/me/companies" \
  -H "GoSmarter-Api-Key: $GOSMARTER_API_KEY"

Example response:

Code
[
  {
    "companyId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Acme Steel Ltd"
  }
]

Copy the companyId value — you'll use it in the next step and in all company-scoped calls.

Step 3: Verify the API is reachable

Code
curl https://api.gosmarter.ai/api/health

Expected response:

Code
{ "status": "healthy" }

The health endpoint requires no authentication — this just confirms connectivity.

Step 4: Make an authenticated call

List mill certificates for your company:

Code
curl "https://api.gosmarter.ai/api/company/$COMPANY_ID/millcert/certificates" \
  -H "GoSmarter-Api-Key: $GOSMARTER_API_KEY"

Replace $COMPANY_ID with the companyId from Step 2.

Next steps

• API Reference — Browse and try every endpoint interactively
• API Keys — Manage, roll, and revoke keys
• Authentication — Using OAuth 2.0 / Bearer tokens for interactive apps
• AI Agent Integration — Connect AI agents via MCP