widgets

Set a widget's launcher image or favicon

Send the image's bytes as the request body, not multipart; Content-Length is required. kind is launcher (shown in place of the launcher's icon), header (shown in place of the icon in the chat's header) or favicon (the hosted page's). PNG, JPEG, WebP or GIF, and ICO for the favicon, up to 256 KB; the format is read from the bytes, whatever the Content-Type, and SVG is refused. Paid plans only (feature_not_available on the free plan). Replaces the previous image and returns the widget, whose settings.launcher_image or settings.favicon now names it. Costs no credits.

PUT/v1/widgets/{widget_id}/images/{kind}

Request

curl --fail-with-body --request PUT \
  --url 'https://api.lookio.app/v1/widgets/<widget_id>/images/<kind>' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary '@document.xlsx'

import { readFile } from "node:fs/promises";

const response = await fetch("https://api.lookio.app/v1/widgets/<widget_id>/images/<kind>", {
  method: "PUT",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/octet-stream"
  },
  body: await readFile("document.xlsx"),
  redirect: "error",
});
if (!response.ok) throw new Error(`Upload failed: ${response.status}`);
const data = await response.json();
console.log(data);

application/json

{
  "data": {
    "id": "wdg_xpatjpwt22fu",
    "name": "Docs chat",
    "assistant_id": "ast_66xcnwtzj8vt",
    "assistant_name": "Support",
    "mode": "flash",
    "status": "live",
    "allowed_domains": [
      "docs.acme.com"
    ],
    "settings": {
      "theme": "auto",
      "accent": "#4F46E5",
      "radius": "medium",
      "bubbles": "corners",
      "position": "bottom-right",
      "launcher": "bubble",
      "launcher_label": "Ask AI",
      "title": "",
      "greeting": "Hi! Ask me anything, I answer from our documentation.",
      "placeholder": "Ask a question…",
      "suggestions": [],
      "disclaimer": "AI answers can be wrong.",
      "language": "auto",
      "sources": "numbered",
      "memory": true,
      "visitor_history": true,
      "feedback": true,
      "branding": true,
      "hosted_page": true,
      "launcher_image": "launcher-3fa9c2d41b7e.png"
    },
    "limits": {
      "per_visitor_hour": 40,
      "per_visitor_day": 150,
      "monthly_credits": null
    },
    "snippets": {
      "bubble": "<script src=\"https://widget.lookio.app/v1/widget.js\" data-lookio-widget=\"wdg_j36h6kb8tyng\" async></script>",
      "embed": "<div data-lookio-embed=\"wdg_j36h6kb8tyng\" style=\"height: 600px\"></div>\n<script src=\"https://widget.lookio.app/v1/widget.js\" async></script>",
      "hosted": "https://widget.lookio.app/w/wdg_j36h6kb8tyng",
      "iframe": "<iframe src=\"https://widget.lookio.app/w/wdg_j36h6kb8tyng?embed=1\" style=\"width: 100%; height: 600px; border: 0\" title=\"Chat\"></iframe>"
    },
    "stats": {
      "conversations": 12,
      "answers": 31,
      "credits": 930
    },
    "created_via": "api",
    "created_at": "2026-10-12T09:30:00.000Z",
    "updated_at": "2026-10-12T09:30:00.000Z"
  },
  "request_id": "req_01K9X7M2Q4"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

Requires assistants:write.

kind is launcher (shown in place of the launcher’s icon, round) or favicon (the hosted page’s tab icon). Send the image’s bytes as the request body, with a Content-Length header. The body is the image itself, not multipart.

Terminalcurl -X PUT "https://api.lookio.app/v1/widgets/WIDGET_ID/images/launcher" \
  -H "Authorization: Bearer $LOOKIO_API_KEY" \
  --data-binary @logo.png

Use --data-binary, not -d: -d alters the bytes. PNG, JPEG, WebP or GIF, and ICO for the favicon, up to 256 KB. The format is read from the bytes, whatever the Content-Type; SVG is refused. A larger image is refused with request_too_large before it is read, and an unsupported one with invalid_parameter. On the free plan the call is refused with feature_not_available.

The previous image is replaced and its file deleted. The widget that comes back names the new image in settings.launcher_image or settings.favicon. Remove it again with Remove a widget’s image.

Authorizations

Authorizationbearerin headerrequired

Path parameters

widget_idstringrequiredpattern: ^wdg_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

kindenum<string>requiredone of: launcher, header, favicon

Body

application/octet-streamrequired

The image's bytes, unencoded. Content-Length is required.

The raw bytes of the file.

Response

application/json

Set a widget's launcher image, header image or favicon

dataobjectrequired

Show child attributes

data.idstringrequiredpattern: ^wdg_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.namestringrequired

data.assistant_idstringrequired

data.assistant_namestringnullrequired

Null when the assistant was deleted: the widget answers nothing until you point it at another.

data.modeenum<string>requiredone of: eco, flash, deep

data.statusenum<string>requiredone of: live, paused

live answers visitors; paused shows nothing and answers nothing, until set live again.

data.allowed_domainsstring[]required

data.settingsobjectrequired

Show child attributes

data.settings.themeenum<string>requireddefault: autoone of: light, dark, auto

light, dark, or auto to follow the visitor's system.

data.settings.accentstringrequireddefault: #4F46E5pattern: ^#[0-9a-fA-F]{6}$

The brand colour of the launcher and the buttons, as #RRGGBB.

data.settings.radiusenum<string>requireddefault: mediumone of: none, small, medium, large

How round the corners are: none, small, medium or large.

data.settings.bubblesenum<string>requireddefault: cornersone of: corners, round

The shape of the visitor's message bubbles and the suggestion chips: corners (default) follows radius, round makes them fully round whatever the corners are. Omit it to leave it as it is.

data.settings.positionenum<string>requireddefault: bottom-rightone of: bottom-right, bottom-left

Which corner of the page the bubble sits in: bottom-right or bottom-left.

data.settings.launcherenum<string>requireddefault: bubbleone of: bubble, pill, bar

bubble: a round button in a corner. pill: a button with launcher_label. bar: a bar centered at the bottom of the page, showing the placeholder, that opens the chat in the middle of the screen (position does not apply).

data.settings.launcher_labelstringrequireddefault: Ask AIlength: ≤ 40 chars

The text of the pill launcher, up to 40 characters.

data.settings.launcher_iconenum<string>requireddefault: chatone of: chat, message, help, sparkles, bot, search, book, bulb, bolt, heart, star, support

The launcher's icon: chat (default), message, help, sparkles, bot, search, book, bulb, bolt, heart, star or support.

data.settings.launcher_sizeenum<string>requireddefault: mediumone of: small, medium, large

The launcher's size, whatever its style: small, medium (default) or large.

data.settings.bar_iconbooleanrequireddefault: true

The bar launcher: show the icon at its start (default). Off: a plain field.

data.settings.bar_translucentbooleanrequireddefault: false

The bar launcher: see-through, with the page blurred behind it. Off (default): a solid bar.

data.settings.launcher_imagestring | nullrequireddefault: null

Paid plans, read-only: the name of the image shown in place of the launcher's icon, set with PUT /v1/widgets/{id}/images/launcher or in the app. Null: the icon.

data.settings.faviconstring | nullrequireddefault: null

Paid plans, read-only: the name of the hosted page's favicon, set with PUT /v1/widgets/{id}/images/favicon or in the app. Null: a favicon drawn from the widget's colour and icon.

data.settings.header_iconenum<string>requireddefault: sparklesone of: chat, message, help, sparkles, bot, search, book, bulb, bolt, heart, star, support, none

The avatar in the chat's header, apart from the launcher's icon: sparkles (default), chat, message, help, bot, search, book, bulb, bolt, heart, star or support; none shows no avatar at all.

data.settings.header_imagestring | nullrequireddefault: null

Paid plans, read-only: the name of the image shown in place of the icon in the chat's header, set with PUT /v1/widgets/{id}/images/header or in the app. Null: the header icon.

data.settings.titlestringrequireddefault: ""length: ≤ 60 chars

The chat's title, up to 60 characters. Empty means the assistant's name.

data.settings.subtitlestringrequireddefault: ""length: ≤ 80 chars

A line under the chat's title, up to 80 characters, like Available 24/7. Empty (default): none, and the title sits centered alone. Omit it to leave it as it is.

data.settings.greetingstringrequireddefault: Hi! Ask me anything, I answer from our documentation.length: ≤ 500 chars

The first message the visitor sees, up to 500 characters.

data.settings.placeholderstringrequireddefault: Ask a question…length: ≤ 80 chars

The hint in the question box, up to 80 characters.

data.settings.suggestionsstring[]requireddefault: []items: ≤ 4 items

Up to 4 example questions (120 characters each) shown before the first question.

data.settings.disclaimerstringrequireddefault: AI answers can be wrong.length: ≤ 200 chars

The small print under the chat, up to 200 characters. Empty hides it.

data.settings.languageenum<string>requireddefault: autoone of: auto, en, fr, de, es, it, pt

The language of the widget's own words (buttons, notices): auto follows the visitor, or en, fr, de, es, it, pt. Answers always follow the visitor's language.

data.settings.sourcesenum<string>requireddefault: numberedone of: numbered, numbered_no_links, inline_links, none

How answers show their sources: numbered ([1] markers and a source list with links to web pages), numbered_no_links (the same without any address), inline_links (the answer links its own words to the source pages, no list; describe the style in the assistant's context) or none.

data.settings.memorybooleanrequireddefault: true

Follow-up questions see the conversation so far.

data.settings.visitor_historybooleanrequireddefault: true

Visitors find their past chats when they come back on the same browser (a random id kept in the chat frame's own storage). Off: nothing is kept in the browser and every visit starts fresh.

data.settings.feedbackbooleanrequireddefault: true

Thumbs up and down under each answer, with an optional word on what was wrong after a thumbs down. Read them in the workspace's logs: GET /v1/logs/conversations?widget_id=…&rating=down lists the conversations where visitors were not satisfied.

data.settings.brandingbooleanrequireddefault: true

Show "Powered by Lookio". Only paid plans may turn it off.

data.settings.bubblebooleanrequireddefault: true

The chat bubble format: a launcher in a corner of the page that opens the chat. On by default. Off: the loader draws nothing.

data.settings.embedbooleanrequireddefault: false

The in-page format: the chat inside a container of your page (snippets.embed, or snippets.iframe). Off by default; off, the frame answers 404.

data.settings.hosted_pagebooleanrequireddefault: false

The hosted page format: a full-page chat at snippets.hosted, to link to. Off by default; off, the page answers 404.

data.limitsobjectrequired

Show child attributes

data.limits.monthly_credits_enabledbooleanrequireddefault: false

data.limits.per_visitor_hourintegerrequireddefault: 40range: 1–500

Questions one visitor may ask per hour, 1 to 500.

data.limits.per_visitor_dayintegerrequireddefault: 150range: 1–2000

Questions one visitor may ask per day, 1 to 2,000, and not fewer than the hourly limit.

data.limits.monthly_creditsinteger | nullrequireddefault: null

Credits the widget may spend per calendar month (UTC), 10 to 10,000,000. Null: no ceiling beyond the workspace's balance. When it is reached the widget stops answering until the month turns.

data.snippetsobjectrequired

Show child attributes

data.snippets.bubblestringrequired

A <script> tag: a launcher in a corner of the page opens the chat. Paste it before </body>.

data.snippets.embedstringrequired

A <div> and the script: the chat fills the div, where you put it. Give the div a height.

data.snippets.hostedstringrequired

A link to a full-page chat. Needs no website; can be turned off with settings.hosted_page.

data.snippets.iframestringrequired

A raw <iframe> for builders that refuse scripts (Notion, some CMS).

data.statsobjectrequired

This calendar month, UTC.

Show child attributes

data.stats.conversationsintegerrequired

data.stats.answersintegerrequired

data.stats.creditsintegerrequired

data.created_viastringnullrequired

data.created_atstringrequired

data.updated_atstringrequired

request_idstringrequired

Set a widget's launcher image or favicon

Authorizations

Path parameters

Body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown