機能の概要
このAPIは、指定されたメモリスペースの名前と説明を更新するために使用します。spaceName と description フィールドのみを更新でき、その他のフィールド（例：dims、providerなど）は変更できません。
呼び出しの詳細
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
PUT {BASE_URL}/api/v1/memory/spaces/{spaceId}
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
| X-OB-Project-ID | はい | {project-id} | プロジェクトID |
リクエストパラメータ
Pathパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| spaceId | string | はい | space-123 | メモリスペースID。 |
Bodyパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| spaceName | string | はい | my-space | スペース名。最大長は128文字です。 |
| description | string | いいえ | A space for storing memories. | スペースの説明。最大長は512文字です。 |
実行結果
レスポンスパラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻りコード |
| message | string | 戻り値 |
| data | object | ビジネスデータ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| id | string | リソースの一意のID |
| name | string | リソース名 |
| status | string | リソースの状態 |
| createTime | string | 作成日時 |
リクエスト例
curl --request PUT '{BASE_URL}/api/v1/memory/spaces/spc-123456' \
--header 'Authorization: Bearer {token}' \
--header 'X-OB-Project-ID: {project-id}' \
--header 'Content-Type: application/json' \
--data '{
"spaceName": "my-space",
"description": "これはテスト用のメモリースペースです"
}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "spc-123456",
"name": "my-space",
"status": "RUNNING",
"createTime": "2026-04-10T10:00:00Z"
}
}