Documentation Index
Fetch the complete documentation index at: https://docs.silicondata.com/llms.txt
Use this file to discover all available pages before exploring further.
Jobs API
POST /api/silicon-mark/v1/jobs
Create a new benchmarking job.
Authorization
🔒OAuth2: OAuth2PasswordBearer
Flow type: password
Token URL: token
Request Body
The request body must be in application/json format.
| Field | Type | Required | Description | Constraints |
|---|
name | string | Yes | Job name | [ 1 .. 60 ] characters |
description | string | No | Job description | Max 512 characters |
benchmarks | array | Yes | List of benchmarks to run | String or object format |
node_count | integer | Yes | Number of expected nodes | [ 1 .. 256 ] |
tags | array | No | Job tags | Max 10 tags, 50 chars each |
Request Example
{
"name": "GPU Benchmark Test",
"description": "Testing new cluster",
"benchmarks": [
"quick_mark",
{
"benchmark_id": "cluster_network",
"config": {}
}
],
"node_count": 4,
"tags": ["production", "gpu"]
}
Responses
{
"id": "7554621440",
"name": "GPU Benchmark Test",
"description": "Testing new cluster",
"node_count": 4,
"benchmarks": ["quick_mark", "cluster_network"],
"tags": ["production", "gpu"],
"token": "eyJ0eXAiOiJKV1Q...",
"created_at": "2024-03-15T10:30:00Z",
"expires_at": "2024-03-16T10:30:00Z"
}
{
"error": {
"code": "PARAMETER_INCORRECT_VALUE",
"message": "Benchmark 'unknown_benchmark' not found"
}
}
{
"error": {
"code": "CLIENT_TOKEN_INVALID",
"message": "Invalid or expired token"
}
}
{
"error": {
"code": "RESOURCE_ALREADY_EXISTS",
"message": "Job with name 'GPU Test' already exists"
}
}
GET /api/silicon-mark/v1/jobs/{job_id}
Get detailed information about a specific job.
Authorization
🔒OAuth2: OAuth2PasswordBearer
Flow type: password
Token URL: token
Path Parameters
| Parameter | Type | Required | Description |
|---|
job_id | string | Yes | The job ID |
Query Parameters
| Parameter | Type | Required | Description | Default |
|---|
include_tasks | boolean | No | Include task summaries | true |
include_results | boolean | No | Include benchmark results | true |
Responses
{
"id": "7554621440",
"name": "GPU Benchmark Test",
"description": "Testing cluster performance",
"state": "completed",
"node_count": 4,
"current_nodes": 4,
"benchmark_sequence": [
{
"benchmark_id": "quick_mark",
"config": {}
},
{
"benchmark_id": "cluster_network",
"config": {}
}
],
"tags": ["production"],
"created_at": "2024-03-15T10:30:00Z",
"started_at": "2024-03-15T10:35:00Z",
"expires_at": "2024-03-16T10:30:00Z",
"ended_at": "2024-03-15T11:45:00Z",
"tasks": [
{
"id": "7554621441",
"job_id": "7554621440",
"machine_uuid": "550e8400-e29b-41d4-a716-446655440000",
"machine_ip": "192.168.1.10",
"state": "completed",
"gpu_model": "NVIDIA A100-SXM4-80GB",
"gpu_count": 8,
"created_at": "2024-03-15T10:35:00Z",
"started_at": "2024-03-15T10:35:30Z",
"ended_at": "2024-03-15T11:40:00Z",
"pdf_report_url": "https://..."
}
],
"benchmark_results": {
"cluster_network": {
"benchmark_id": "cluster_network",
"started_at": "2024-03-15T10:40:00Z",
"completed_at": "2024-03-15T10:55:00Z",
"config": {},
"results": {
"avg_bandwidth_gbps": 45.2,
"avg_latency": 0.8,
"min_bandwidth_gbps": 42.1,
"total_links_tested": 12
},
"state": "completed",
"error_message": null
}
},
"pdf_report_url": "https://..."
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Job with id 7554621440 not found"
}
}
GET /api/silicon-mark/v1/jobs
List jobs with filtering and pagination.
Authorization
🔒OAuth2: OAuth2PasswordBearer
Flow type: password
Token URL: token
Query Parameters
| Parameter | Type | Required | Description | Default |
|---|
page | integer | No | Page number | 1 |
per_page | integer | No | Items per page (max: 300) | 20 |
sort_by | string | No | Field to sort by | created_at |
sort_order | string | No | Sort direction (asc/desc) | desc |
state | string | No | Filter by job state | |
name | string | No | Filter by name (partial match) | |
benchmark_id | string | No | Filter by benchmark in sequence | |
tag | string | No | Filter by tag | |
created_after | datetime | No | Jobs created after this timestamp | |
created_before | datetime | No | Jobs created before this timestamp | |
node_count_min | integer | No | Minimum node count | |
node_count_max | integer | No | Maximum node count | |
Responses
{
"data": [
{
"id": "7554621440",
"name": "GPU Benchmark Test",
"description": "Testing cluster",
"state": "completed",
"node_count": 4,
"current_nodes": 4,
"benchmark_sequence": [
{
"benchmark_id": "quick_mark",
"config": {}
},
{
"benchmark_id": "cluster_network",
"config": {}
}
],
"benchmarks": ["quick_mark", "cluster_network"],
"tags": ["production"],
"created_at": "2024-03-15T10:30:00Z",
"started_at": "2024-03-15T10:35:00Z",
"expires_at": "2024-03-16T10:30:00Z",
"ended_at": "2024-03-15T11:45:00Z"
}
],
"pagination": {
"page": 1,
"per_page": 20,
"total": 42,
"pages": 3
}
}
GET /api/silicon-mark/v1/jobs/{job_id}/results
Get the result summary of this job.
Authorization
🔒OAuth2: OAuth2PasswordBearer
Flow type: password
Token URL: token
Path Parameters
| Parameter | Type | Required | Description |
|---|
job_id | string | Yes | The job ID |
Query Parameters
| Parameter | Type | Required | Description | Default |
|---|
include_display_name | boolean | No | Include human-readable field names | false |
Responses
{
"job_id": "7554621440",
"name": "GPU Benchmark Test",
"description": "Testing cluster",
"created_at": "2024-03-15T10:30:00Z",
"started_at": "2024-03-15T10:35:00Z",
"ended_at": "2024-03-15T11:45:00Z",
"node_count": 4,
"benchmark_results": {
"cluster_network": {
"benchmark_id": "cluster_network",
"started_at": "2024-03-15T10:40:00Z",
"completed_at": "2024-03-15T10:55:00Z",
"config": {},
"results": {
"avg_bandwidth_gbps": 45.2,
"avg_latency": 0.8,
"min_bandwidth_gbps": 42.1,
"total_links_tested": 12,
"node_count": 4,
"measurements": [...]
},
"state": "completed",
"error_message": null
}
}
}
