List Logs

GET

List all Logs for the given filter criteria.

Query parameters

file_idstringRequired

Unique identifier for the File to list Logs for.

pageintegerOptional>=1Defaults to 1

Page number for pagination.

sizeintegerOptional>=0Defaults to 10

Page size for pagination. Number of Logs to fetch.

version_idstringOptional

If provided, only Logs belonging to the specified Version will be returned.

version_statusenumOptional

If provided, only Logs belonging to Versions with the specified status will be returned.

Allowed values: uncommittedcommitteddeleted

idstringOptional

If provided, returns Logs whose IDs contain any of the specified values as substrings.

searchstringOptional

If provided, only Logs that contain the provided string in its inputs and output will be returned.

metadata_searchstringOptional

If provided, only Logs that contain the provided string in its metadata will be returned.

start_datedatetimeOptional

If provided, only Logs created after the specified date will be returned.

end_datedatetimeOptional

If provided, only Logs created before the specified date will be returned.

include_parentbooleanOptionalDefaults to false

If true, include the full parent Log in the response. Only applicable when retrieving Evaluator Logs.

in_trace_filterbooleanOptional

If true, return Logs that are associated to a Trace. False, return Logs that are not associated to a Trace.

sampleintegerOptional>=0

If provided, limit the response to a random subset of logs from the filtered results. (This will be an approximate sample, not a strict limit.)

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Errors

GET

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

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

Built with

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

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