Retrieve project

POST

/v1/private/projects/retrieve

POST

/api/v1/private/projects/retrieve

$ curl -X POST http://localhost:5173/api/v1/private/projects/retrieve \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "string"
> }'

1 {
2   "name": "string",
3   "id": "string",
4   "visibility": "private",
5   "description": "string",
6   "created_at": "2024-01-15T09:30:00Z",
7   "created_by": "string",
8   "last_updated_at": "2024-01-15T09:30:00Z",
9   "last_updated_by": "string",
10   "last_updated_trace_at": "2024-01-15T09:30:00Z",
11   "feedback_scores": [
12     {
13       "name": "string",
14       "value": 1.1
15     }
16   ],
17   "duration": {
18     "p50": 1.1,
19     "p90": 1.1,
20     "p99": 1.1
21   },
22   "total_estimated_cost": 1.1,
23   "total_estimated_cost_sum": 1.1,
24   "usage": {},
25   "trace_count": 1,
26   "thread_count": 1,
27   "guardrails_failed_count": 1,
28   "error_count": {
29     "count": 1,
30     "deviation": 1,
31     "deviation_percentage": 1
32   }
33 }

Retrieve project

Request

This endpoint expects an object.

namestringRequired>=1 character

includeStatsbooleanOptional

Response

Project resource

namestring>=1 character

idstringOptionalRead-onlyformat: "uuid"

visibilityenumOptional

descriptionstringOptional0-255 characters

created_atdatetimeOptionalRead-only

created_bystringOptionalRead-only

last_updated_atdatetimeOptionalRead-only

last_updated_bystringOptionalRead-only

last_updated_trace_atdatetimeOptionalRead-only

feedback_scoreslist of objectsOptionalRead-only

durationobjectOptionalRead-only

total_estimated_costdoubleOptionalRead-only

total_estimated_cost_sumdoubleOptionalRead-only

usagemap from strings to doublesOptionalRead-only

trace_countlongOptionalRead-only

thread_countlongOptionalRead-only

guardrails_failed_countlongOptionalRead-only

error_countobjectOptionalRead-only

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error