Humanloop Documentation and API Reference

Export all logged datapoints associated to your project.

Results are paginated and sorts the datapoints based on created_at in descending order.

Path parameters

idstringRequired

String ID of project. Starts with pr_.

Query parameters

pageintegerOptional

Page offset for pagination.

sizeintegerOptional

Page size for pagination. Number of logs to export.

Response

This endpoint returns an object

recordslist of objects

Request model for logging a datapoint.

pageinteger

sizeinteger

totalinteger

Errors

1 curl -X POST https://api.humanloop.com/v4/projects/id/export \ 2 -H "X-API-KEY: <apiKey>"

1 { 2 "records": [ 3 { 4 "project": "project", 5 "project_id": "project_id", 6 "session_id": "session_id", 7 "session_reference_id": "session_reference_id", 8 "parent_id": "parent_id", 9 "parent_reference_id": "parent_reference_id", 10 "inputs": { 11 "key": "value" 12 }, 13 "source": "source", 14 "metadata": { 15 "key": "value" 16 }, 17 "save": true, 18 "source_datapoint_id": "source_datapoint_id", 19 "id": "id", 20 "reference_id": "reference_id", 21 "messages": [ 22 { 23 "role": "user" 24 } 25 ], 26 "output": "output", 27 "judgment": true, 28 "config_id": "config_id", 29 "config": { 30 "type": "generic", 31 "id": "config", 32 "status": "config", 33 "name": "config" 34 }, 35 "environment": "environment", 36 "feedback": [ 37 { 38 "type": "rating", 39 "value": true, 40 "id": "id" 41 } 42 ], 43 "created_at": "2024-01-15T09:30:00Z", 44 "error": "error", 45 "stdout": "stdout", 46 "duration": 1.1, 47 "output_message": { 48 "role": "user" 49 }, 50 "prompt_tokens": 1, 51 "output_tokens": 1, 52 "prompt_cost": 1.1, 53 "output_cost": 1.1, 54 "provider_request": { 55 "key": "value" 56 }, 57 "provider_response": { 58 "key": "value" 59 }, 60 "user": "user", 61 "provider_latency": 1.1, 62 "tokens": 1, 63 "raw_output": "raw_output", 64 "finish_reason": "finish_reason", 65 "tools": [ 66 { 67 "id": "id", 68 "name": "name", 69 "signature": "signature", 70 "result": "result" 71 } 72 ], 73 "tool_choice": "none", 74 "evaluation_results": [ 75 { 76 "id": "id", 77 "evaluator_id": "evaluator_id", 78 "evaluator_version_id": "evaluator_version_id", 79 "log_id": "log_id", 80 "updated_at": "2024-01-15T09:30:00Z", 81 "created_at": "2024-01-15T09:30:00Z" 82 } 83 ], 84 "observability_status": "pending", 85 "updated_at": "2024-01-15T09:30:00Z", 86 "batch_ids": [ 87 "batch_ids" 88 ] 89 } 90 ], 91 "page": 1, 92 "size": 1, 93 "total": 1 94 }

1	curl -X POST https://api.humanloop.com/v4/projects/id/export \
2	-H "X-API-KEY: <apiKey>"

1	{
2	"records": [
3	{
4	"project": "project",
5	"project_id": "project_id",
6	"session_id": "session_id",
7	"session_reference_id": "session_reference_id",
8	"parent_id": "parent_id",
9	"parent_reference_id": "parent_reference_id",
10	"inputs": {
11	"key": "value"
12	},
13	"source": "source",
14	"metadata": {
15	"key": "value"
16	},
17	"save": true,
18	"source_datapoint_id": "source_datapoint_id",
19	"id": "id",
20	"reference_id": "reference_id",
21	"messages": [
22	{
23	"role": "user"
24	}
25	],
26	"output": "output",
27	"judgment": true,
28	"config_id": "config_id",
29	"config": {
30	"type": "generic",
31	"id": "config",
32	"status": "config",
33	"name": "config"
34	},
35	"environment": "environment",
36	"feedback": [
37	{
38	"type": "rating",
39	"value": true,
40	"id": "id"
41	}
42	],
43	"created_at": "2024-01-15T09:30:00Z",
44	"error": "error",
45	"stdout": "stdout",
46	"duration": 1.1,
47	"output_message": {
48	"role": "user"
49	},
50	"prompt_tokens": 1,
51	"output_tokens": 1,
52	"prompt_cost": 1.1,
53	"output_cost": 1.1,
54	"provider_request": {
55	"key": "value"
56	},
57	"provider_response": {
58	"key": "value"
59	},
60	"user": "user",
61	"provider_latency": 1.1,
62	"tokens": 1,
63	"raw_output": "raw_output",
64	"finish_reason": "finish_reason",
65	"tools": [
66	{
67	"id": "id",
68	"name": "name",
69	"signature": "signature",
70	"result": "result"
71	}
72	],
73	"tool_choice": "none",
74	"evaluation_results": [
75	{
76	"id": "id",
77	"evaluator_id": "evaluator_id",
78	"evaluator_version_id": "evaluator_version_id",
79	"log_id": "log_id",
80	"updated_at": "2024-01-15T09:30:00Z",
81	"created_at": "2024-01-15T09:30:00Z"
82	}
83	],
84	"observability_status": "pending",
85	"updated_at": "2024-01-15T09:30:00Z",
86	"batch_ids": [
87	"batch_ids"
88	]
89	}
90	],
91	"page": 1,
92	"size": 1,
93	"total": 1
94	}