Get a project

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

{
  "Kitsu API MCP server": {
    "url": "https://api-docs.kitsu.cloud/mcp"
  }
}

GET /data/projects/{instance_id}

Jwt authorization

Get a project. You must be in the team of the project, or an administrator. The response gives project_status_name. With relations (the default), it also gives the metadata descriptors, the task type priorities, the task status links and the asset type workflows. A client gets only the descriptors shared with clients. A vendor gets only the descriptors of their departments.

Path parameters

instance_id string(uuid) Required

Unique identifier of the project

Query parameters

relations boolean

Add the related data. The default value is true.

Default value is true.

Responses

200 application/json

The project
Hide response attributes Show response attributes object
- id string(uuid)
- name string
- production_type string
- production_style string
- project_status_id string(uuid)
- project_status_name string
- descriptors array[object]
  
  Metadata descriptors of the project, narrowed to the ones published to a client or to the departments of a vendor
- task_types_priority object
  
  Priority of each task type, by id
- task_statuses_link object
  
  Priority and board roles of each task status, by id
- asset_type_workflows object
  
  Task type ids of the workflows that the project sets, by asset type id. An asset type without an entry follows the studio workflow.
  
  Hide asset_type_workflows attribute Show asset_type_workflows attribute object
  
  * array[string(uuid)] Additional properties
- first_episode_id string(uuid)
- created_at string(date-time)
- updated_at string(date-time)
400

The identifier is not a valid UUID
403

You are not in the team of the project
404

The project does not exist

GET /data/projects/{instance_id}

curl -X GET "http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25?relations=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

import requests

url = "http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {
    "relations": true
}
payload = None

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

response.raise_for_status()

if response.content:
    print(response.json())

Response examples (200)

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c250",
  "name": "Project Name",
  "production_type": "feature",
  "production_style": "2d3d",
  "project_status_id": "b24a6ea4-ce75-4665-a070-57453082c250",
  "project_status_name": "Open",
  "descriptors": [
    {}
  ],
  "task_types_priority": {},
  "task_statuses_link": {},
  "asset_type_workflows": {
    "additionalProperty1": [
      "string"
    ],
    "additionalProperty2": [
      "string"
    ]
  },
  "first_episode_id": "c24a6ea4-ce75-4665-a070-57453082c250",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}