canonical: https://jentic.com/apis/gyazo.com/gyazo

# Gyazo API

Jentic publishes the only available OpenAPI specification for Gyazo API, keeping it validated and agent-ready. Gyazo is a screenshot and image-sharing tool, and its API exposes the user's image library for programmatic upload, listing, retrieval, deletion, and search. The five-endpoint surface lets developers automate screenshot capture flows, build moderation tooling, or pull images into downstream apps. Authentication is via bearer access token tied to a Gyazo user account.

## For AI agents

Upload, list, search, retrieve, and delete screenshots and images in a Gyazo user library through five REST endpoints.

## Scope

Does not handle video transcoding, image transformation, or DRM - use for personal-account screenshot upload, listing, search, and deletion only.

## Capabilities

- Upload an image to a Gyazo user account and receive the public share URL
- List the authenticated user's image library with pagination
- Retrieve a single image record by image ID
- Search a user's images by query string
- Delete an image from a Gyazo account by image ID

## Use cases

### Automated screenshot capture pipeline

Capture screenshots from a desktop or browser-automation flow and post them to Gyazo to obtain a shareable URL for embedding in support tickets, bug reports, or release notes. The upload endpoint accepts the binary file and returns the canonical permalink, which downstream systems then store on the bug record.

Example prompt: POST `/api/upload` with the screenshot file and store the returned permalink on the matching ticket record.

### Personal image library audit

List the authenticated user's Gyazo library to audit historical screenshots - for example before changing employer or cleaning up sensitive captures. The list and search endpoints support pagination and query filtering, and the delete endpoint removes images that should no longer be public.

Example prompt: GET `/api/images` with paging, filter the results by capture date, and DELETE matching image IDs after user approval.

### Knowledge-base screenshot ingestion

A documentation tool searches an author's Gyazo account for the relevant screenshots when generating a knowledge-base article and embeds them by permalink. The search endpoint returns image IDs and URLs that the doc tool inserts into the article body without manual download and re-upload.

Example prompt: GET `/api/search` with query 'login screen' and embed the top three results into the article draft.

### AI agent screenshot helper via Jentic

An AI assistant captures a UI screenshot during a tutorial-creation flow, uploads it to Gyazo, and inserts the returned permalink into the generated tutorial markdown. Through Jentic the agent calls the upload endpoint without managing the SDK.

Example prompt: Search Jentic for 'upload a screenshot to gyazo', load POST `/api/upload`, and execute with the captured image bytes.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/images` | List user's images |
| GET | `/api/images/{image_id}` | Get image by ID |
| DELETE | `/api/images/{image_id}` | Delete an image |
| POST | `/api/upload` | Upload an image |
| GET | `/api/search` | Search images |

## Key resources

- **Images** — List, retrieve, and delete images in the user's Gyazo library
- **Upload** — Upload new screenshots and images to the user's account
- **Search** — Search the user's image library by query string

## Why Jentic

- **Setup:** Wiring the Gyazo API by hand means handling its bearer access token and splitting calls between the api.gyazo.com and upload.gyazo.com hosts while managing retries yourself. Through Jentic you install once, import Gyazo from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Gyazo puts the image id in the URL path (`/api/images/{image_id}`), so a rule can pin your agent to one image: it can fetch that image and nothing else. You choose the operations it may call, so deleting an image is not included unless you add it.
- **Credential handling:** Your Gyazo access token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'upload a screenshot to Gyazo' or 'search my images', and Jentic returns the matching operation with its input schema, including the image-file field, so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Imgur** — Public image hosting platform with upload and album APIs
- **Flickr** — Photo-sharing platform with rich metadata, albums, and tagging
- **Urlbox** — Server-side webpage screenshot rendering

## FAQ

### Why is there no official OpenAPI spec for Gyazo API?

Gyazo does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Gyazo API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Gyazo API use?

Gyazo uses HTTP bearer authentication with an access token issued from the user's Gyazo account. Pass it as Authorization: Bearer <token>. Through Jentic, the token is stored encrypted in the vault and only scoped tokens are passed to the executing agent.

### Can I upload a screenshot programmatically with the Gyazo API?

Yes. POST `/api/upload` accepts the image file and returns the canonical permalink for the new image record. This is the same endpoint the Gyazo desktop client uses internally.

### Can I search my Gyazo library by query with the Gyazo API?

Yes. GET `/api/search` returns image records that match the query string, scoped to the authenticated user's library. Combine it with GET `/api/images` for paginated browsing of the full library.

### What are the rate limits for the Gyazo API?

Gyazo applies user-account rate limits typically measured in tens of requests per minute on the free tier with higher limits for paid plans. Back off on 429 responses and avoid bulk-deleting an entire library in one tight loop.

### How do I upload a screenshot through the Gyazo API via Jentic?

Search Jentic for 'upload a screenshot to gyazo', load the POST `/api/upload` operation, then execute with the image bytes. Install with pip install jentic.

### Can I limit what my agent is allowed to do with the Gyazo API?

Yes. Because you self-host Jentic One, your own rules decide which of the five Gyazo operations the agent may call, so you can grant it upload and search while excluding DELETE `/api/images/{image_id}` unless you explicitly add it. Since the image id sits in the URL path, a rule can pin the agent to a single image so it retrieves that one record and nothing else. Your Gyazo access token stays under your control and is only injected for the operations you have allowed.
