List projects

GET

/api/v1/projects

GET

/api/v1/projects

$ curl https://alephant.io/api/v1/projects \
>      -H "Authorization: Authorization" \
>      -H "X-Workspace-Id: X-Workspace-Id"

1 {
2   "data": [
3     {
4       "activeAgentCount": 1,
5       "activeMemberCount": 1,
6       "analyticsStatus": "string",
7       "cost": 1.1,
8       "createdAt": "2024-01-15T09:30:00Z",
9       "description": "string",
10       "id": "string",
11       "name": "string",
12       "requests": 1,
13       "tokens": 1,
14       "updatedAt": "2024-01-15T09:30:00Z"
15     }
16   ],
17   "meta": {
18     "overview": {
19       "totalActiveAgents": 1,
20       "totalActiveMembers": 1,
21       "totalPeriodCost": 1.1,
22       "totalPeriodRequests": 1,
23       "totalPeriodTokens": 1,
24       "totalProjects": 1
25     },
26     "page": 1,
27     "pageSize": 1,
28     "period": {
29       "end": "2024-01-15T09:30:00Z",
30       "key": "1d",
31       "start": "2024-01-15T09:30:00Z",
32       "timezone": "string"
33     },
34     "total": 1,
35     "totalPages": 1
36   }
37 }

List projects for an Enterprise workspace. Supports pagination, search, sorting, and analytics period filters; when Collector analytics is configured, cost, requests, and tokens are merged from project assignments. All workspace members may read; PATs require the read scope.

查询参数

pageinteger可选>=0默认为 1

Page number; 0 or omitted uses default 1

pageSizeinteger可选0-100默认为 12

Items per page; 0 or omitted uses default 12

searchstring可选

Search by project name or description

sortByenum可选默认为 updatedAt

Sort field

允许的值:

sortDirenum可选默认为 desc

Sort direction

允许的值:

periodenum可选默认为 7d

Analytics period

允许的值:

响应

data: list, meta: pagination and overview

datalist of objects可选

metaobject可选

错误

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

请求头

查询参数

响应

错误