Skip to content

Commit 782de6f

Browse files
committed
add user metadata documentation
1 parent 8739a6a commit 782de6f

2 files changed

Lines changed: 816 additions & 1 deletion

File tree

developer/agents/memory.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,15 @@ curl -X GET \
402402
-H "Authorization: Token <token>"
403403
```
404404

405+
**Query Parameters:**
406+
407+
| Parameter | Type | Description |
408+
|-----------|------|-------------|
409+
| `session_id` | string | Filter memories by source session ID |
410+
| `content` | string | Case-insensitive search within memory content |
411+
| `start_date` | ISO 8601 date | Filter memories created on or after this date |
412+
| `end_date` | ISO 8601 date | Filter memories created on or before this date |
413+
405414
**Response:**
406415
```json
407416
{
@@ -423,6 +432,36 @@ curl -X GET \
423432
}
424433
```
425434

435+
**Filtering Examples:**
436+
437+
**Filter by session:**
438+
```bash
439+
curl -X GET \
440+
"https://api.ibl.ai/api/ai-mentor/orgs/acme/users/user123/global-memories/?session_id=abc-123-def" \
441+
-H "Authorization: Token <token>"
442+
```
443+
444+
**Search by content:**
445+
```bash
446+
curl -X GET \
447+
"https://api.ibl.ai/api/ai-mentor/orgs/acme/users/user123/global-memories/?content=software%20engineer" \
448+
-H "Authorization: Token <token>"
449+
```
450+
451+
**Filter by date range:**
452+
```bash
453+
curl -X GET \
454+
"https://api.ibl.ai/api/ai-mentor/orgs/acme/users/user123/global-memories/?start_date=2024-01-01&end_date=2024-01-31" \
455+
-H "Authorization: Token <token>"
456+
```
457+
458+
**Combined filters:**
459+
```bash
460+
curl -X GET \
461+
"https://api.ibl.ai/api/ai-mentor/orgs/acme/users/user123/global-memories/?content=python&start_date=2024-01-01" \
462+
-H "Authorization: Token <token>"
463+
```
464+
426465
#### Create Global Memory
427466

428467
```bash
@@ -693,7 +732,7 @@ curl -X DELETE \
693732

694733
| Method | Endpoint | Description |
695734
|--------|----------|-------------|
696-
| GET | `/orgs/{org}/users/{user_id}/global-memories/` | List global memories |
735+
| GET | `/orgs/{org}/users/{user_id}/global-memories/` | List global memories (supports filtering by session_id, content, start_date, end_date) |
697736
| POST | `/orgs/{org}/users/{user_id}/global-memories/` | Create global memory |
698737
| DELETE | `/orgs/{org}/users/{user_id}/global-memories/{id}/` | Delete global memory |
699738
| GET | `/orgs/{org}/users/{user_id}/mentor-memories/` | List all mentor memories |

0 commit comments

Comments
 (0)