API docs by Redocly

AI Plan Chat API (1.0.0)

Download OpenAPI specification:

AIによるタスク生成アプリのAPI

GetHealth

Health check のためのエンドポイント

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

GetTaskList

タスクの一覧取得

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateTask

タスクの新規作成

Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters

タスクのタイトル

description
string or null

タスクの説明

due_at
string or null <date-time>

タスクの期限

status
string
Default: "todo"
Enum: "todo" "in_progress" "done"

タスクの状態

priority
string or null
Enum: "low" "medium" "high"

タスクの優先度

interpretation_id
string or null <uuid>

このタスクを作成したAI解釈のID

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "due_at": "2019-08-24T14:15:22Z",
  • "status": "todo",
  • "priority": "low",
  • "interpretation_id": "fb746e7d-efab-4269-b8d8-74bd8aa7a79d"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "title": "string",
  • "source": "manual",
  • "description": "string",
  • "due_at": "2019-08-24T14:15:22Z",
  • "status": "todo",
  • "priority": "low",
  • "interpretation_id": "fb746e7d-efab-4269-b8d8-74bd8aa7a79d",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

GetTask

タスクの単一取得

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "title": "string",
  • "source": "manual",
  • "description": "string",
  • "due_at": "2019-08-24T14:15:22Z",
  • "status": "todo",
  • "priority": "low",
  • "interpretation_id": "fb746e7d-efab-4269-b8d8-74bd8aa7a79d",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

UpdateTask

タスクの更新

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
title
required
string [ 1 .. 255 ] characters

タスクのタイトル

description
string or null

タスクの説明

due_at
string or null <date-time>

タスクの期限

status
required
string
Enum: "todo" "in_progress" "done"

タスクの状態

priority
string or null
Enum: "low" "medium" "high"

タスクの優先度

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "due_at": "2019-08-24T14:15:22Z",
  • "status": "todo",
  • "priority": "low"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "title": "string",
  • "source": "manual",
  • "description": "string",
  • "due_at": "2019-08-24T14:15:22Z",
  • "status": "todo",
  • "priority": "low",
  • "interpretation_id": "fb746e7d-efab-4269-b8d8-74bd8aa7a79d",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

EditTask

タスクの編集

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
title
string [ 1 .. 255 ] characters

タスクのタイトル

description
string or null

タスクの説明

due_at
string or null <date-time>

タスクの期限

status
string
Enum: "todo" "in_progress" "done"

タスクの状態

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "due_at": "2019-08-24T14:15:22Z",
  • "status": "todo"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "title": "string",
  • "source": "manual",
  • "description": "string",
  • "due_at": "2019-08-24T14:15:22Z",
  • "status": "todo",
  • "priority": "low",
  • "interpretation_id": "fb746e7d-efab-4269-b8d8-74bd8aa7a79d",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

DeleteTask

タスクの削除

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

GoogleCallback

Google OAuth 2.0コールバック処理

Request Body schema: application/json
required
code
required
string

Google OAuthから返されたauthorization code

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "jwt_token": "string",
  • "user": {
    }
}

CreateInterpretation

自然言語入力によるAI解析

Authorizations:
BearerAuth
Request Body schema: application/json
required
input_text
required
string [ 1 .. 10000 ] characters

自然言語テキスト

Responses

Request samples

Content type
application/json
{
  • "input_text": "string"
}

Response samples

Content type
application/json
{
  • "type": "todo",
  • "interpretation": {
    },
  • "message": "string"
}

ListInterpretations

AI解析履歴の取得

Authorizations:
BearerAuth
query Parameters
type
string
Enum: "todo" "event" "reminder" "note" "expense" "unknown"

AI解析のtype絞り込み

limit
integer [ 1 .. 100 ]
Default: 20

取得件数（デフォルト: 20）

offset
integer >= 0
Default: 0

オフセット（ページネーション）

Responses

Response samples

Content type
application/json
{
  • "interpretations": [
    ],
  • "total": 0,
  • "limit": 0,
  • "offset": 0
}

GetInterpretation

特定のAI解析結果の詳細取得

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>

AI解釈ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  • "input_text": "string",
  • "structured_result": {
    },
  • "ai_model": "string",
  • "ai_prompt_tokens": 0,
  • "ai_completion_tokens": 0,
  • "created_at": "2019-08-24T14:15:22Z"
}

GetInterpretationItems

AI解釈に紐づくアイテム一覧を取得

path Parameters
id
required
string <uuid>

AI解釈ID

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

ApproveMultipleInterpretationItems

複数のアイテムを一括承認してリソースを作成（トランザクション）

path Parameters
id
required
string <uuid>

AI解釈ID

Request Body schema: application/json
required
item_ids
required
Array of strings <uuid> non-empty [ items <uuid > ]

承認するアイテムIDの配列

Responses

Request samples

Content type
application/json
{
  • "item_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "resource_ids": {
    }
}

GetInterpretationItem

アイテムの詳細取得

path Parameters
id
required
string <uuid>

アイテムID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "interpretation_id": "fb746e7d-efab-4269-b8d8-74bd8aa7a79d",
  • "item_index": 0,
  • "resource_type": "task",
  • "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  • "status": "pending",
  • "data": { },
  • "original_data": { },
  • "reviewed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

UpdateInterpretationItem

アイテムのdata内容を編集（pending状態のみ）

path Parameters
id
required
string <uuid>

アイテムID

Request Body schema: application/json
required
required
object

更新後のアイテム内容（JSON）

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "interpretation_id": "fb746e7d-efab-4269-b8d8-74bd8aa7a79d",
  • "item_index": 0,
  • "resource_type": "task",
  • "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  • "status": "pending",
  • "data": { },
  • "original_data": { },
  • "reviewed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

ApproveInterpretationItem

アイテムを承認してリソース（タスク等）を作成

path Parameters
id
required
string <uuid>

アイテムID

Responses

Response samples

Content type
application/json
{
  • "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f"
}