Base URLs and Environments

The public API base path is:

/public/v1

The full origin depends on the environment and workspace deployment.

Always combine the environment origin with /public/v1.

Keep base URLs separate from tokens. The base URL decides where the request goes; the token decides which workspace and abilities the request has.

Find the Current Base URL

1. Open Settings.
2. Go to API.
3. Copy API base URL from the overview section.

The same page also shows links to:

• The human-readable API docs.
• The OpenAPI document.

Environment Differences

Local development, staging, and production can use different origins. Do not hard-code a production URL into development or staging scripts. Store the base URL in an environment variable such as AGILED_API_BASE_URL.

Keep tokens separated by environment too. A staging script should not use a production API key.

Use separate environment variables for local, staging, and production. Review deployment settings before enabling writes so a test job does not create records in production.

Example

export AGILED_API_BASE_URL="https://api.example.com"
curl "$AGILED_API_BASE_URL/public/v1/me" \
  -H "Authorization: Bearer $AGILED_API_TOKEN"

Run /me first in each environment. It confirms the base URL, token, and workspace scope before your integration writes records.

Common Mistakes

• Using the docs URL instead of the API URL.
• Omitting /public/v1.
• Using a production token against staging or a staging token against production.
• Copying a workspace app URL instead of the API origin shown in settings.
• Hard-coding a URL in a script that later runs in another environment.

Troubleshooting

If every endpoint returns not found, confirm the origin and /public/v1 path.

If /me works but another endpoint fails, the base URL is probably correct; move on to endpoint path, method, permissions, or request body.

Deployment Checklist

Before moving an integration between environments, review the base URL, token, webhook target URLs, stored external IDs, and any scheduled jobs. Disable or pause jobs while changing configuration so a staging script does not write to production or a production job does not call a test receiver.

After deployment, run /public/v1/me, one read request, and one low-risk write request in the target environment before enabling broad sync.

Related Docs

• API Reference
• Test the API Locally