Skip to content

Overview

GALE provides secured APIs to manage agents/tools, models, guardrails, prompts, files, and evaluations. Developers can perform key activities like deployment, import/export, monitoring, analytics, billing, and reporting using these APIs at the appropriate endpoints.

API Key Authentication

Public APIs require an API key for authentication and authorization. The account owner or admin can generate this key in the Settings console.

An API key serves as a unique identifier for the client or application accessing the API, ensuring security and access control. It helps:

  • Authenticate requests – Verify the identity of the client.
  • Control access – Restrict API usage based on permissions or rate limits.
  • Monitor usage – Track API calls for analytics, billing, or debugging.
  • Prevent abuse – Protect against unauthorized or excessive use.

API keys are typically included in request headers or parameters to validate access.

Note

Each API key includes created on and last used dates to track its usage history.

How to Find the API Key?

  1. Login to GALE and access the Settings Console.

  2. On the left menu, click Security & Control -> Management API keys.

  3. Click the Create API key button if you are creating an API key for the first time. create api key

Otherwise, click Create.

management api keys

  1. In the Create new API key dialog, provide a name and click Generate Key. create a new api key
  2. Once the key is successfully generated, click Copy and Close to copy the API key. copy api key

List of APIs

Currently, the following APIs are available:

SCOPE API DESCRIPTION
File Management File Upload API To upload a small or large public file in the allowed format.
View Process Status Get Dock Status API To check the status of an ongoing or completed job related to tools or models.
Manage a Tool (Agent) Import a New Tool API To import a new tool into the system.
Import to an Existing Tool API To import new configurations, datasets, or updates into an already existing tool within the system.
Export a Tool API To export an existing tool's configuration and associated data, including its flow, for backup, sharing, or reuse.
Deploy a Tool API To deploy a specific tool into an environment.
Undeploy a Tool API To undeploy a specific tool from an environment.
Manage a Model Import a Model API Import a model in chunks into the system.
Export a Model API To export a trained AI model from the system.
Deploy a Model API To deploy a model into the environment in the Ready to Deploy state and configure its parameters. The initial deployment must be done manually in the GALE account. Consecutive deployments must happen via the public API.
Undeploy a Model API To undeploy a model from the environment.
Manage Guardrails Deploy Guardrails API To deploy predefined guardrails into the system.
Undeploy Guardrails API To undeploy predefined guardrails from the system.