Get an annotated frame of a preview

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api-docs.kitsu.cloud/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Kitsu API MCP server": {
    "url": "https://api-docs.kitsu.cloud/mcp"
  }
}
Close
GET /actions/preview-files/{preview_file_id}/extract-annotated-frame
Jwt authorization

Get a frame of a movie preview, or the picture of a picture preview, with the annotation of this frame on it. For a movie, frame_number is required. For a picture, frame_number is ignored. You must be a manager of the project.

Path parameters

  • preview_file_id string(uuid) Required

    Unique identifier of the preview file

Query parameters

  • frame_number integer

    Number of the frame, from 1. Movies only.

    Minimum value is 1.

Responses

  • 200 image/png

    The PNG picture
  • 400

    There is no annotation, frame_number is missing for a movie, or the extension is not supported

  • 403

    You are not a manager of the project

  • 404

    The file of the preview is not available

GET /actions/preview-files/{preview_file_id}/extract-annotated-frame 
curl \
 --request GET '/api/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c250/extract-annotated-frame' \
 --header "Authorization: $API_KEY"