/pixiv/artworks

POST /api/pixiv/artworks

Price: 5 credits

Get one pixiv illustration, manga or ugoira: title, caption, tags with translations, author, image URLs for every page, ugoira frames, counters, series position, age rating and AI flag

How to use it

Works rated sensitivity_level 4 or higher come back without image URLs; their metadata is complete.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• artwork string required — pixiv artwork id or artwork URL (examples: "150271332", "https://www.pixiv.net/artworks/150271332"; minLength: 1)

Response

• @type string (default: "PixivArtwork")
• id string required
• url string required
• artwork_type string nullable
• description string nullable
• description_html string nullable
• age_rating string nullable
• sensitivity_level integer nullable
• is_ai_generated boolean nullable
• image string nullable
• original_image string nullable
• thumbnail string nullable
• pages array (default: [])
  • @type string (default: "PixivArtworkPage")
  • index integer required
  • image string nullable
  • original_image string nullable
  • thumbnail string nullable
  • width integer nullable
  • height integer nullable
• ugoira object nullable
  • @type string (default: "PixivUgoira")
  • archive string nullable
  • original_archive string nullable
  • mime_type string nullable
  • frames array (default: [])
    • @type string (default: "PixivUgoiraFrame")
    • file string required
    • duration number nullable
• tags array (default: [])
  • @type string (default: "PixivArtworkTag")
  • name string required
  • romaji string nullable
  • translation string nullable
  • is_locked boolean nullable
• author object nullable
  • @type string (default: "PixivUserRef")
  • id string required
  • name string nullable
  • alias string nullable
  • image string nullable
  • url string required
• width integer nullable
• height integer nullable
• page_count integer nullable
• bookmark_count integer nullable
• like_count integer nullable
• comment_count integer nullable
• view_count integer nullable
• image_response_count integer nullable
• is_original boolean nullable
• is_howto boolean nullable
• is_unlisted boolean nullable
• is_login_only boolean nullable
• is_comment_off boolean nullable
• series object nullable
  • @type string (default: "PixivSeriesNav")
  • id string required
  • series_type string nullable
  • order integer nullable
  • previous_id string nullable
  • next_id string nullable
• title_translation string nullable
• description_translation string nullable
• created_at integer nullable
• uploaded_at integer nullable
• reuploaded_at integer nullable

Errors

• 422 — artwork is not a pixiv artwork id or URL Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No public pixiv artwork under that id Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.