List

GET

Get a list of Sessions.

Query parameters

file_idstringOptional

Unique identifier for File to return Sessions for. Sessions that contain any Logs associated to this File will be returned.

version_idstringOptional

Unique identifier for Version to return Sessions for. Sessions that contain any Logs associated to this Version will be returned.

pageintegerOptional

Page number for pagination.

sizeintegerOptional

Page size for pagination. Number of Sessions to fetch.

Response

This endpoint returns an object.

recordslist of objects

pageinteger

sizeinteger

totalinteger

Errors

GET

1 curl -G https://api.humanloop.com/v5/sessions \
2      -H "X-API-KEY: <apiKey>" \
3      -d size=1 \
4      -d file_id=pr_123abc

1 {
2   "records": [
3     {
4       "id": "sesh_456hij",
5       "created_at": "2024-05-01T12:00:00Z",
6       "updated_at": "2024-05-01T12:00:00Z",
7       "events": [
8         {
9           "log": {
10             "id": "log_123efg",
11             "created_at": "2024-05-01T12:00:00Z",
12             "output": "This is a sample output.",
13             "prompt": {
14               "id": "pr_123abc",
15               "name": "Test Prompt",
16               "path": "test-prompt",
17               "version_id": "pv_456def",
18               "created_at": "2024-05-01T12:00:00Z",
19               "updated_at": "2024-05-01T12:00:00Z",
20               "status": "committed",
21               "last_used_at": "2024-05-01T12:00:00Z",
22               "model": "gpt-4",
23               "version_logs_count": 1,
24               "total_logs_count": 1,
25               "inputs": [
26                 {
27                   "name": "question"
28                 }
29               ]
30             },
31             "evaluator_logs": []
32           },
33           "children": []
34         }
35       ],
36       "logs_count": 1
37     }
38   ],
39   "page": 1,
40   "size": 11,
41   "total": 1
42 }

Built with

1	curl -G https://api.humanloop.com/v5/sessions \
2	-H "X-API-KEY: <apiKey>" \
3	-d size=1 \
4	-d file_id=pr_123abc

1	{
2	"records": [
3	{
4	"id": "sesh_456hij",
5	"created_at": "2024-05-01T12:00:00Z",
6	"updated_at": "2024-05-01T12:00:00Z",
7	"events": [
8	{
9	"log": {
10	"id": "log_123efg",
11	"created_at": "2024-05-01T12:00:00Z",
12	"output": "This is a sample output.",
13	"prompt": {
14	"id": "pr_123abc",
15	"name": "Test Prompt",
16	"path": "test-prompt",
17	"version_id": "pv_456def",
18	"created_at": "2024-05-01T12:00:00Z",
19	"updated_at": "2024-05-01T12:00:00Z",
20	"status": "committed",
21	"last_used_at": "2024-05-01T12:00:00Z",
22	"model": "gpt-4",
23	"version_logs_count": 1,
24	"total_logs_count": 1,
25	"inputs": [
26	{
27	"name": "question"
28	}
29	]
30	},
31	"evaluator_logs": []
32	},
33	"children": []
34	}
35	],
36	"logs_count": 1
37	}
38	],
39	"page": 1,
40	"size": 11,
41	"total": 1
42	}