Matrix
Matrix release and management API
| Method | Path | Description |
|---|
| GET | /api/v1/matrix/{workspace} | List matrices |
| GET | /api/v1/matrix/{workspace}/{matrixId} | Get matrix details |
GET /api/v1/matrix/{workspace}
Retrieve a list of unique matrices deployed in the system
| Name | Required | Description |
|---|
workspace | Yes | Workspace identifier |
| Name | Required | Type | Description |
|---|
prefix | No | string | Prefix to filter matrices (optional - filters by matrix URI prefix) |
page | No | integer(int32) | Page number (1-indexed) |
pageSize | No | integer(int32) | Page size |
| Status | Description |
|---|
200 | List of matrices retrieved successfully |
500 | Internal server error |
| Field | Type | Description |
|---|
id | string (uuid) | Unique identifier for the matrix |
uri | string | URI of the matrix |
name | string | Display name of the matrix |
description | string | Description of the matrix |
repositoryUrl | string | Repository URL for the matrix source code |
imports | MatrixReference[] | Matrices that this matrix imports (dependencies) |
importedBy | MatrixReference[] | Matrices that import this matrix (reverse dependencies) |
packageInfo | PackageSummary | Summary of a package installation |
createdAt | string (date-time) | Timestamp when the matrix was created |
updatedAt | string (date-time) | Timestamp when the matrix was last updated |
prefixDeclarations | PrefixDeclarationResponse[] | Prefix declarations owned by this matrix |
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string",
"description": "string",
"repositoryUrl": "string",
"imports": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string"
}
],
"importedBy": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string"
}
],
"packageInfo": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "string",
"currentVersion": "string"
},
"createdAt": "2025-03-28T14:22:03Z",
"updatedAt": "2025-03-28T14:22:03Z",
"prefixDeclarations": [
{
"prefix": "string",
"namespaceUri": "string"
}
]
}
}
curl -X GET "https://poliglot.io/api/v1/matrix/my-workspace" \
-H "Authorization: Bearer <your-token>"
GET /api/v1/matrix/{workspace}/{matrixId}
Retrieve details for a specific matrix
| Name | Required | Description |
|---|
workspace | Yes | Workspace identifier |
matrixId | Yes | Matrix ID |
| Status | Description |
|---|
200 | Matrix details retrieved successfully |
404 | Matrix not found |
| Field | Type | Description |
|---|
id | string (uuid) | Unique identifier for the matrix |
uri | string | URI of the matrix |
name | string | Display name of the matrix |
description | string | Description of the matrix |
repositoryUrl | string | Repository URL for the matrix source code |
imports | MatrixReference[] | Matrices that this matrix imports (dependencies) |
importedBy | MatrixReference[] | Matrices that import this matrix (reverse dependencies) |
packageInfo | PackageSummary | Summary of a package installation |
createdAt | string (date-time) | Timestamp when the matrix was created |
updatedAt | string (date-time) | Timestamp when the matrix was last updated |
prefixDeclarations | PrefixDeclarationResponse[] | Prefix declarations owned by this matrix |
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string",
"description": "string",
"repositoryUrl": "string",
"imports": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string"
}
],
"importedBy": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"uri": "string",
"name": "string"
}
],
"packageInfo": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "string",
"currentVersion": "string"
},
"createdAt": "2025-03-28T14:22:03Z",
"updatedAt": "2025-03-28T14:22:03Z",
"prefixDeclarations": [
{
"prefix": "string",
"namespaceUri": "string"
}
]
}
}
curl -X GET "https://poliglot.io/api/v1/matrix/my-workspace/<matrixId>" \
-H "Authorization: Bearer <your-token>"