Change the annotations 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
PUT /actions/preview-files/{preview_file_id}/update-annotations

Change the annotations of a preview. Give the annotations to add in additions, the annotations to change in updates, and the annotations to delete in deletions. Managers and clients of the project can use this route. A supervisor can use it for the tasks of their departments, or for all the tasks if the supervisor has no department. Other users cannot use this route.

Path parameters

  • preview_file_id string(uuid) Required

    Unique identifier of the preview file

application/json

Body Required

  • additions array[object]

    Annotations to add

  • updates array[object]

    Annotations to update

  • deletions array[string(uuid)]

    Annotation IDs to remove

Responses

  • 200 application/json

    The preview with its annotations

    Hide response attributes Show response attributes object
    • id string(uuid)

      Preview file unique identifier

    • annotations array[object]

      Updated annotations

  • 400

    additions, updates or deletions is not a list

  • 403

    You cannot change the annotations of this preview

  • 404

    The preview file does not exist

PUT /actions/preview-files/{preview_file_id}/update-annotations
curl -X PUT "http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/update-annotations" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "additions": [
    {
      "type": "drawing",
      "x": 100,
      "y": 200
    }
  ],
  "updates": [
    {
      "id": "uuid",
      "x": 150,
      "y": 250
    }
  ],
  "deletions": [
    "a24a6ea4-ce75-4665-a070-57453082c25"
  ]
}'
import requests

url = "http://api.example.com/actions/preview-files/a24a6ea4-ce75-4665-a070-57453082c25/update-annotations"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
}
params = {}
payload = {
    "additions": [
        {
            "type": "drawing",
            "x": 100,
            "y": 200
        }
    ],
    "updates": [
        {
            "id": "uuid",
            "x": 150,
            "y": 250
        }
    ],
    "deletions": [
        "a24a6ea4-ce75-4665-a070-57453082c25"
    ]
}

response = requests.put(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
Request examples
{
  "additions": [
    {
      "type": "drawing",
      "x": 100,
      "y": 200
    }
  ],
  "updates": [
    {
      "id": "uuid",
      "x": 150,
      "y": 250
    }
  ],
  "deletions": [
    "a24a6ea4-ce75-4665-a070-57453082c250"
  ]
}
Response examples (200)
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c250",
  "annotations": [
    {}
  ]
}