Getting started

Create your project and key

1. Register in the Customer portal and complete any required email verification.
2. Create a project for this integration.
3. Open API keys, select the project and copy the key once. Save it in your server’s secret configuration.

You need the API origin provided for your deployment and an HTTP client: cURL, or Node.js 20+ for the context example. The full image script uses Node.js 24. A project key identifies one project; it does not create projects or manage your account.

Confirm your assigned plan permits the media operation you choose. Projects and key administration explains the account boundary.

Configure your environment

# Bash. Use the API origin supplied for your deployment (no /v1 suffix).
export IMAZEO_API_ORIGIN='https://api.imazeo.com'
read -r -s -p 'Project API key: ' IMAZEO_API_KEY; printf '\n'
export IMAZEO_API_KEY

The origin has no /v1 suffix. Use HTTPS outside loopback development. Bash’s hidden prompt keeps the key out of command history; keep the shell environment private and do not commit it. In another shell, set the same variables through its secure prompt or secret manager.

These are request examples for your configured deployment, not a promise that a public production endpoint is available.

Make your first request

curl --fail-with-body --silent --show-error \
  "$IMAZEO_API_ORIGIN/v1/api-key/context" \
  --header "X-API-Key: $IMAZEO_API_KEY"

GET /v1/api-key/context checks the key’s project context without uploading a file or consuming a processing credit. Authentication and rate limits still apply.

{
  "success": true,
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "keyId": "22222222-2222-4222-8222-222222222222"
  },
  "meta": {
    "requestId": "example-context-request"
  }
}

Use the returned projectId in project-scoped paths. The response contains projectId and keyId, not subscription limits or the secret key.

export IMAZEO_PROJECT_ID='PASTE_PROJECT_ID_FROM_CONTEXT'

A 401 means the credentials need attention; a 403 can indicate disabled access. Use troubleshooting before retrying.

Choose a media workflow

Next, learn which outputs persist, how usage is counted and how to keep keys private.