Skip to content
NEBULA

nebula@atheron:/docs$

// Docs

One API for every job

REST, JSON and a webhook.

Submit a batch, follow it, and download the result. The full reference lives in the developer portal, beside your keys.

Keys

Make keys in the developer portal once your team has passed the business check and added a card. Send a key as a Bearer token.

  • Test keys start with ath_test_, run up to 100 items a batch on Atheron's own machines, and never charge your card
  • Live keys start with ath_live_ and run real jobs
  • A key needs the nebula right to submit jobs
  • Keys are shown once and stored only as a hash
Open the full docs

Webhooks

When a batch finishes, we send batch.completed to your webhook address, signed so you can check it came from us. A failed delivery is retried for 3 days.

In the full reference

  • Quick start
  • Tasks and models
  • Input formats
  • Results and retention
  • Shareable and private jobs
  • Fine-tuning jobs
  • Webhooks and signatures
  • Errors and limits
  • Usage and billing

Endpoints

Every request and answer is JSON.

  • POST /api/v1/nebula/batches

    Submit a batch: the task, the model, your items, whether it is shareable, and a webhook address.

  • GET /api/v1/nebula/batches/{id}

    A batch's state and how many shards are done.

  • GET /api/v1/nebula/batches/{id}/results

    A short-lived link to the result file, once the batch is done.

  • POST /api/v1/nebula/batches/{id}/cancel

    Stop a batch. Finished shards are kept and billed.

  • GET /api/v1/nebula/models

    The model catalogue, with each model's task, licence and limits.

Example

Submit a batch
curl https://developers.aton-network.org/api/v1/nebula/batches \
  -H "Authorization: Bearer $ATHERON_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "task": "embed",
    "model": "bge-base-en-v1.5",
    "shareable": false,
    "items": [
      { "id": "doc-1", "text": "Machine learning on a shared network." },
      { "id": "doc-2", "text": "Every result is checked twice." }
    ],
    "webhook": "https://example.com/hooks/nebula"
  }'
Check on it
curl https://developers.aton-network.org/api/v1/nebula/batches/bat_123 \
  -H "Authorization: Bearer $ATHERON_KEY"

{ "id": "bat_123", "state": "running", "shards": { "done": 12, "total": 40 } }
Open the full docs

A question the docs do not answer? Talk to our team.

Contact sales