Dataczar
Browse helpers

API Reference / ai / help

List the available AI helpers and their payloads.

Returns a catalog of the AI entry points (`/ai/text`, `/ai/image`, `/ai/interpret`, `/ai/edit`) along with the expected fields for each helper. This is the canonical way to fetch up-to-date docs straight from the Lambda.

GET/ai/help

Where this helper shines

List the available AI helpers and their payloads. keeps ai helpers on autopilot. Use it whenever you need to list the available AI helpers and their payloads without pausing a sprint or asking design/dev to jump in.

  • Trigger this helper whenever you need to list the available AI helpers and their payloads without waiting on a full deploy.
  • Drop it into automations (Zapier, Make, workers) to list the available AI helpers and their payloads as part of your workflow.
  • Share the GET URL so support and success can list the available AI helpers and their payloads safely using their Dataczar API key.

Copy & ship snippets

GET

Instant link

GET https://api.dataczar.app/ai/help?ak=demo

Open directly in any browser, webhook, or low-code workflow.

curl

curl GET

curl "https://api.dataczar.app/ai/help?ak=demo"

Swap ak=demo with your Dataczar API key.

Responses

Status 200

AI help payload with per-command docs.

{
  "ok": true,
  "status": 200,
  "service": "ai",
  "commands": {
    "POST /ai/text": {
      "body": {
        "prompt": "Describe the helper you need",
        "model": "(optional) defaults to gpt-4o-mini",
        "temperature": 0.2,
        "max_tokens": 512
      }
    },
    "POST /ai/image": {
      "body": {
        "prompt": "Describe the image to create",
        "model": "(optional) defaults to dall-e-3",
        "size": "(optional) defaults to 1024x1024"
      }
    },
    "POST /ai/interpret": {
      "body": {
        "prompt": "Optional instruction for the description",
        "image_base64": "<base64 data> (or image_url)",
        "model": "(optional) defaults to gpt-4o-mini"
      }
    },
    "POST /ai/edit": {
      "body": {
        "prompt": "Describe how to edit the image",
        "image_base64": "<base64 data> (or image_url)",
        "mask_base64": "Optional mask (or mask_url)",
        "model": "(optional) defaults to dall-e-3"
      }
    }
  }
}

Examples

Request

"GET /ai/help?ak=demo"

Response

{
  "ok": true,
  "service": "ai",
  "commands": {
    "POST /ai/text": {
      "body": {
        "prompt": "Describe the helper you need",
        "model": "(optional) defaults to gpt-4o-mini",
        "temperature": 0.2,
        "max_tokens": 512
      }
    }
  },
  "status": 200
}

Query parameters

No query params for this helper.
Equivalent curl
Grab your Dataczar API key
Every helper runs with the same simple API key. Sign in (or create a free Dataczar account) at Dataczar Connect to issue keys in seconds, then drop the key into any `ak=` parameter and start shipping.
Get your API keyBrowse helpers
Tip: reuse the same key across these helpers, or rotate keys per project from the Connect dashboard.