Get

1 import requests 2 3 url = "https://api.humanloop.com/v4/projects/id" 4 5 headers = {"X-API-KEY": "<apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "id": "id", 3 "name": "name", 4 "users": [ 5 { 6 "id": "id", 7 "email_address": "email_address", 8 "full_name": "full_name" 9 } 10 ], 11 "data_count": 1, 12 "feedback_types": [ 13 { 14 "type": "rating", 15 "values": [ 16 { 17 "value": "value", 18 "sentiment": "positive" 19 } 20 ] 21 } 22 ], 23 "team_id": "team_id", 24 "created_at": "2024-01-15T09:30:00Z", 25 "updated_at": "2024-01-15T09:30:00Z", 26 "active_config": { 27 "project_id": "project_id", 28 "project_name": "project_name", 29 "created_at": "2024-01-15T09:30:00Z", 30 "updated_at": "2024-01-15T09:30:00Z", 31 "last_used": "2024-01-15T09:30:00Z", 32 "config": { 33 "type": "model", 34 "id": "id", 35 "model": "model", 36 "chat_template": [ 37 { 38 "role": "user" 39 } 40 ], 41 "description": "description", 42 "endpoint": "complete", 43 "frequency_penalty": 1.1, 44 "max_tokens": 1, 45 "name": "name", 46 "other": { 47 "key": "value" 48 }, 49 "presence_penalty": 1.1, 50 "prompt_template": "prompt_template", 51 "provider": "openai", 52 "reasoning_effort": "high", 53 "response_format": { 54 "type": "json_object" 55 }, 56 "seed": 1, 57 "stop": "stop", 58 "temperature": 1.1, 59 "template_language": "default", 60 "tools": [ 61 { 62 "id": "id", 63 "name": "name" 64 } 65 ], 66 "top_p": 1.1, 67 "tool_configs": [ 68 { 69 "id": "id", 70 "status": "status", 71 "name": "name" 72 } 73 ] 74 }, 75 "num_datapoints": 1, 76 "evaluation_aggregates": [ 77 { 78 "model_config_id": "model_config_id", 79 "evaluator_id": "evaluator_id", 80 "evaluator_version_id": "evaluator_version_id" 81 } 82 ] 83 }, 84 "config_type": "generic", 85 "active_evaluators": [ 86 { 87 "name": "name", 88 "description": "description", 89 "arguments_type": "target_free", 90 "return_type": "boolean", 91 "type": "python", 92 "id": "id", 93 "created_at": "2024-01-15T09:30:00Z", 94 "updated_at": "2024-01-15T09:30:00Z", 95 "code": "code", 96 "model_config": { 97 "id": "id", 98 "model": "model" 99 } 100 } 101 ], 102 "directory_id": "directory_id" 103 }

Get a specific project.

Path parameters

idstringRequired

String ID of project. Starts with pr_.

Response

Successful Response

idstring

Project ID

namestring

Unique project name.

userslist of objects

Users associated to the project.

data_countinteger

The count of datapoints that have been logged to the project.

feedback_typeslist of objects

The feedback types that have been defined in the project.

team_idstring

Unique ID of the team the project belongs to. Starts with tm_.

created_atdatetime

updated_atdatetime

active_configobjectOptional

Config that has been set as the project’s active deployment.

config_typeenumOptional

An enumeration.

Allowed values:

active_evaluatorslist of objectsOptional

Evaluators that have been set as active for the project.

directory_idstringOptional

String ID of the directory the project belongs to. Starts with dir_.

Path parameters

Headers

Response

Errors