REST API
The Go AMS REST API allows you to integrate the platform with your own systems and applications. With it, you can create, monitor, and manage automations programmatically.
Overview
The REST API is a feature available for Business (corporate) accounts. To use it, you need to generate an API Key from a Tenant. With this key, you can authenticate requests and access all available routes.
Explore the full API documentation on SwaggerHow to get access
Have a Business account
The API is available only for Business accounts. If you have an Individual account, you won't have access to this feature.
Create a Tenant
Within your Business account, create a Tenant (isolated environment). The Tenant is where the API Key will be generated.
Generate the API Key
In the Tenant settings, generate the API Key. This key will be used in the authentication header of all your requests.
Use in requests
Include the API Key in the authentication header to access the API routes.
Authentication
All API requests must include the API Key in the authentication header. The key identifies the Tenant and grants access to that environment's resources.
Main routes
The API provides routes for managing the platform's main resources:
Processes
List, create, and manage automation processes.
GET /processes — List all processes
POST /processes — Create a new process
products.api.routeProcessEx3
Jobs
Create jobs, monitor executions, and query results.
GET /jobs — List all jobs
POST /jobs — Create a new job
products.api.routeJobEx3
Runners
Query status and information of registered Runners.
GET /runners — List Runners
products.api.routeRunnerEx2
products.api.routeRunnerEx3
Queues
Manage queues and query processed items.
GET /queues — List queues
POST /queues — Create a queue
products.api.routeQueueEx3
Schedules
Create and manage automatic schedules.
GET /schedules — List schedules
POST /schedules — Create a schedule
products.api.routeScheduleEx3
Assets
Manage shared resources.
GET /assets — List assets
POST /assets — Create an asset
products.api.routeAssetEx3
Important
The routes and examples above are illustrative. Refer to the full API documentation within the platform for updated endpoints, parameters, and detailed examples.
Limits and best practices
When using the API, consider the following:
Keep your API Key secure — do not expose it in public repositories or client-side code.
Each API Key is linked to a specific Tenant and accesses only that Tenant's resources.
Requests are subject to rate limiting. Avoid sending too many simultaneous requests.
Use the API for automation and integration — for manual use, prefer the platform interface.