Analyze an image or website URL
Analyzes an image (by URL) or a public website and returns a description, style hints, a suggested mascot name, and a suggested prompt ready to feed into POST /v1/mascots. When type=url, the response also includes a screenshot (omitted from example for brevity). No credit cost.
Select Masko-API-Version: 2026-09-26 (or api_version=2026-09-26) for the canonical mascot contract shown first. Existing unversioned clients keep legacy collection fields. A mascot_id query filter also selects the canonical contract. Mixing identifier names returns 400.
Request
- Base URL: https://api.masko.ai
- URL: https://api.masko.ai/v1/analyze
- Auth: HTTP bearer
Query parameters
Equivalent to the version header, for polling URLs and clients that accept only relative paths. Header and query must agree.
Headers
Account-scoped key (1 to 255 characters, ideally a UUID). Retries must preserve the credential workspace, effective API version, URL, content type and exact body bytes, including multipart boundaries; different inputs return 409 idempotency_key_reused. Completed responses, including 500 errors, replay for 24 hours after completion with current resource access checked again. Running or unconfirmed executions return 409 idempotency_request_in_progress and do not expire automatically. A receipt persistence failure returns 503 idempotency_persistence_failed: retry only with the same key and inspect the operation outcome before starting a new request.
Use 2026-09-26 for mascot_id resource fields. Unversioned shared routes retain the legacy contract.
Request body
Response
Analysis result (image or url)
Changes
No recorded changes to this operation across all 1 revision of this API.