Import images and PDF pages
import_mediaBring a PDF or an image into the project as media: comic pages, hand-drawn storyboards, style or reference pictures. A PDF becomes one image per page (at most 50 pages per call; pass pages for the others). An image file is page 1.
findPanels: true finds the panels of each page (comic panels, storyboard frames) and cuts each one as its own image, labelled "Page N, panel K" with a one-line caption of what it shows. Use it for comic pages and storyboard boards: it is more precise than boxes you place yourself, and you need not see the pages first. It costs about 1 credit per page; when more than 20 pages need it, the call returns confirmation_required with the estimate: ask the user, then call again with confirm: true. Pages already searched cost nothing again. With mediaId, it finds the panels of that stored image.
crops cuts boxes out of pages: each box becomes its own image, stored next to the page and linked to it. Boxes are fractions of the page (x, y from the top-left corner, width, height, all from 0 to 1), so a box over the top half of a page is { x: 0, y: 0, width: 1, height: 0.5 }. You decide the boxes (comic panels, storyboard frames, webtoon strips); the tool only cuts the pixels. At most 300 crops per call. To cut boxes from a page imported earlier, pass its mediaId and crops. When you cannot see the pages (a PDF is often not shown to you as images), import without crops first, look at the pages with view_media and their media ids, then cut them with mediaId and crops.
Pass one source: uploadId (from create_upload: the way to send a file you hold), url (a public https URL), base64 with mimeType (files up to 1024 KB only) or mediaId (crops of stored media). Up to 25 MB per file.
Returns the media id, size and page of every page and crop (with panelsFound per page, and panelsFailed for a page the model could not read: cut that one with crops), and the panel spend. Importing the same file again returns the same media ids and stores nothing twice. Without findPanels the import is free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Public https URL of the file. | |
| crops | No | Boxes to cut out, each stored as its own image. | |
| pages | No | PDF pages to import (1-based). Default: all pages, up to 50. Pages that crops name are imported too. | |
| base64 | No | The file as base64, for files up to 1024 KB. Use create_upload for larger files. | |
| confirm | No | True once the user agreed to the findPanels estimate (needed above 20 pages). | |
| mediaId | No | Media id of a stored image (a page imported earlier) to cut crops from. | |
| fileName | No | Name of the file, shown with its media (base64 or url). | |
| mimeType | No | Type of the base64 file. | |
| uploadId | No | uploadId from create_upload, once the file was PUT to its uploadUrl. | |
| projectId | Yes | ScreenWeaver project id (from list_projects). | |
| findPanels | No | True to find the panels of each page and cut each one (costs credits). |