Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.eggapi.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Base URL

https://api.eggapi.ai

Authentication

Use an API key from the dashboard:
Authorization: Bearer YOUR_API_KEY

Public Model Scope

The current published public catalog exposes only nano-banana. Use nanobanana as the model value in API requests.

Request Format

  • Use HTTPS.
  • Send JSON bodies with Content-Type: application/json.
  • Include Authorization: Bearer YOUR_API_KEY.

Response Envelope

Success:
{
  "data": {},
  "error": null
}
Error:
{
  "data": null,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "request validation failed"
  }
}

Status Codes

StatusMeaning
200Request succeeded.
202Async generation task was created.
400Bad request or validation error.
401Missing or invalid credentials.
403Forbidden or insufficient balance.
404Resource not found.
429Rate limited.
500Internal backend error.
502Upstream provider error.
503Service unavailable.

Pagination

List endpoints use:
ParameterDefaultMax
page1-
per_page20100
Paginated responses return data.items and data.pagination.

Endpoints

POST /v1/generate

Create a nano-banana image generation or image editing task.

GET /v1/tasks/{id}

Get one task by ID.

GET /v1/tasks

List your generation tasks.

GET /v1/usage

List usage records.