Change the annotations of a shared 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
PUT /shared/playlists/{token}/annotations

Change the annotations of a preview of the shared playlist. The body uses the same additions, updates and deletions as the route for users. A guest can change only the annotations of this guest. The guest must be a guest of this link. You do not need an account. The token of the link is the credential. If the link has a password, give it in the password query parameter.

Path parameters

  • token string Required

    Share link token

Query parameters

  • password string

    Password when the link is protected

application/json

Body Required

  • guest_id string(uuid) Required
  • preview_file_id string(uuid) Required
  • additions array[object]
  • updates array[object]
  • deletions array[string(uuid)]

Responses

  • 200 application/json

    Updated preview file with the new annotations

  • 400

    Missing required body fields

  • 403

    Annotations are disabled for this link, the guest is not a guest of this link, or the preview is not in the shared playlist

  • 404

    The link is not valid, has expired, or the password is missing or wrong, or the preview file does not exist

PUT /shared/playlists/{token}/annotations
curl \
 --request PUT '/api/shared/playlists/{token}/annotations' \
 --header "Content-Type: application/json" \
 --data '{
  "guest_id": "string",
  "preview_file_id": "string",
  "additions": [
    {}
  ],
  "updates": [
    {}
  ],
  "deletions": [
    "string"
  ]
}'
Request examples
{
  "guest_id": "string",
  "preview_file_id": "string",
  "additions": [
    {}
  ],
  "updates": [
    {}
  ],
  "deletions": [
    "string"
  ]
}
Response examples (200)
{}