For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
DocsReferenceChangelog
DocsReferenceChangelog
  • Introduction
    • Overview
    • Errors
  • SDK
    • Overview
    • Decorators
    • Run Evaluation
  • API
      • GETList Logs
      • DELDelete Logs
      • GETGet Log
LogoLogo
Sign inBook a demo
APILogs

List Logs

GET
https://api.humanloop.com/v5/logs
GET
/v5/logs
$curl -G https://api.humanloop.com/v5/logs \
>     -H "X-API-KEY: <apiKey>" \
>     -d file_id=file_123abc \
>     -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        "last_used_at": "2024-05-01T12:00:00Z",
15        "model": "gpt-4",
16        "version_logs_count": 1,
17        "total_logs_count": 1,
18        "inputs": [
19          {
20            "name": "question"
21          }
22        ]
23      },
24      "evaluator_logs": []
25    }
26  ],
27  "page": 1,
28  "size": 1,
29  "total": 1
30}
List all Logs for the given filter criteria.
Was this page helpful?
Previous

Delete Logs

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

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.
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.)

include_trace_childrenbooleanOptionalDefaults to false

If true, populate trace_children for the retrieved Logs. Only applicable when retrieving Flow or Agent Logs.

Response

Successful Response
recordslist of objects
pageinteger
sizeinteger
totalinteger

Errors

422
List Logs Get Request Unprocessable Entity Error