API

In Gigantics, API keys are used to invoke datasets, pipelines, and jobs from external systems (CI/CD, scripts, etc.). Below is the updated flow:

Creating an API Key

1. Go to the project section.
2. Click Create API key and enter a purpose/description to identify it.
3. The key and the base URL will be displayed. Copy the key and store it in a safe place (it will not be shown again).
4. In the key list you will see the purpose, part of the identifier, date/time, and the number of invocations. From there you can revoke, edit, or delete the key.

Authentication

Every request to the API must include the key using one of these methods:

• HTTP header

  Authorization: Bearer <API_KEY>

• URL parameter

  <GIGANTICS_ENDPOINT>?api_key=<API_KEY>

Examples with curl

Header

curl -X POST "<GIGANTICS_PIPELINE_ENDPOINT>" \
     -H "Authorization: Bearer <API_KEY>"

URL parameter

curl -X POST "<GIGANTICS_PIPELINE_ENDPOINT>?api_key=<API_KEY>"

Store the key in an environment variable or in your CI/CD platform's secret manager to avoid exposing it.

Endpoints

The full URLs (including organization, project, model, and resource) are shown in the Gigantics interface when you assign the API key. All you need is the API key and the provided URL.

Response when running a pipeline

When a pipeline starts, Gigantics responds with:

{
  "job_id": "64c8c45b8a5f1e001a3db9aa",
  "job_url": "https://<host>/api/job/64c8c45b8a5f1e001a3db9aa"
}

• job_id: Internal identifier of the job.
• job_url: URL to check its status. Once the job finishes (status = completed) and the pipeline generates a dataset, the link to the resulting dataset will appear at this same URL.