TeaLab API (0.1.0)

Download OpenAPI specification:

Multi-tenant job orchestration API with JWT auth and SSE telemetry.

catalog

Get feature catalog

Authorizations:

BearerAuth

Responses

Response samples

200
401
403
500

Content type

application/json

{"features": [{"category": "string",
"description": "string",
"key": "string"
}
],
"packages": [{"description": "string",
"features": [{"feature_key": "string",
"state": "string"
}
],
"id": "string",
"name": "string"
}
]
}

sessions

List all sessions (superuser)

Authorizations:

BearerAuth

query Parameters

limit	integer Page size (max 1000)
cursor	string Pagination cursor

Responses

Response samples

200
401
403

Content type

application/json

{"has_more": true,
"next_cursor": "string",
"sessions": [{"created_at": "string",
"expires_at": "string",
"id": "string",
"last_ip": "string",
"last_used_at": "string",
"tenant_id": "string",
"user_agent": "string",
"user_email": "string",
"user_id": "string"
}
],
"total": 0
}

List sessions for a tenant (admin)

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

query Parameters

limit	integer Page size (max 1000)
cursor	string Pagination cursor

Responses

Response samples

200
401
403

Content type

application/json

{"has_more": true,
"next_cursor": "string",
"sessions": [{"created_at": "string",
"expires_at": "string",
"id": "string",
"last_ip": "string",
"last_used_at": "string",
"tenant_id": "string",
"user_agent": "string",
"user_email": "string",
"user_id": "string"
}
],
"total": 0
}

List sessions for current user

Authorizations:

BearerAuth

query Parameters

limit	integer Page size (max 1000)
cursor	string Pagination cursor

Responses

Response samples

200
401

Content type

application/json

{"has_more": true,
"next_cursor": "string",
"sessions": [{"created_at": "string",
"expires_at": "string",
"id": "string",
"last_ip": "string",
"last_used_at": "string",
"tenant_id": "string",
"user_agent": "string",
"user_email": "string",
"user_id": "string"
}
],
"total": 0
}

Revoke a session

Authorizations:

BearerAuth

path Parameters

sessionID

required

string

Session ID

Responses

Response samples

200
401
403
404

Content type

application/json

{"property1": "string",
"property2": "string"
}

notices

List system notices

Authorizations:

BearerAuth

query Parameters

limit	integer Page size (max 1000)
cursor	string Pagination cursor

Responses

Response samples

200
400
401
403

Content type

application/json

{"has_more": true,
"next_cursor": "string",
"notices": [{"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
}
],
"total": 0
}

Create or update a system notice

Authorizations:

BearerAuth

Request Body schema: application/json
required

Notice payload

body	string
cta_label	string
cta_url	string
dismissible	boolean
ends_at	string
id	string
severity	string
starts_at	string
tenant_id	string
title	string

Responses

Request samples

Payload

Content type

application/json

{"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
}

Response samples

200
400
401
403

Content type

application/json

{"property1": {"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
},
"property2": {"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
}
}

Delete a system notice

Authorizations:

BearerAuth

path Parameters

noticeID

required

string

Notice ID

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"property1": "string",
"property2": "string"
}

List notices for a tenant

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

query Parameters

limit	integer Page size (max 1000)
cursor	string Pagination cursor

Responses

Response samples

200
400
401
403

Content type

application/json

{"has_more": true,
"next_cursor": "string",
"notices": [{"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
}
],
"total": 0
}

Create or update a tenant notice

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

Request Body schema: application/json
required

Notice payload

body	string
cta_label	string
cta_url	string
dismissible	boolean
ends_at	string
id	string
severity	string
starts_at	string
tenant_id	string
title	string

Responses

Request samples

Payload

Content type

application/json

{"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
}

Response samples

200
400
401
403

Content type

application/json

{"property1": {"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
},
"property2": {"body": "string",
"cta_label": "string",
"cta_url": "string",
"dismissible": true,
"ends_at": "string",
"id": "string",
"severity": "string",
"starts_at": "string",
"tenant_id": "string",
"title": "string"
}
}

Delete a tenant notice

Authorizations:

BearerAuth

path Parameters

tenantID required	string Tenant ID
noticeID required	string Notice ID

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"property1": "string",
"property2": "string"
}

tenants

List tenants (superuser)

Authorizations:

BearerAuth

Responses

Response samples

200
401
403
500

Content type

application/json

{ }

Get tenant summary (admin)

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

Responses

Response samples

200
400
401
403
500

Content type

application/json

{ }

List tenant overrides (admin)

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

query Parameters

limit	integer Page size (max 200)
cursor	string Pagination cursor

Responses

Response samples

200
400
401
403
500

Content type

application/json

{ }

List role overrides for a tenant (admin)

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

query Parameters

limit	integer Page size (max 200)
cursor	string Pagination cursor

Responses

Response samples

200
400
401
403
500

Content type

application/json

{ }

List roles for a tenant (admin)

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

Responses

Response samples

200
400
401
403
500

Content type

application/json

{ }

List users for a tenant (admin)

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

query Parameters

limit	integer Page size (max 1000)
cursor	string Pagination cursor

Responses

Response samples

200
400
401
403
500

Content type

application/json

{ }

audit

List audit events for a tenant (admin)

Authorizations:

BearerAuth

path Parameters

tenantID

required

string

Tenant ID

query Parameters

limit	integer Page size (max 200)
cursor	string Pagination cursor

Responses

Response samples

200
400
401
403
500

Content type

application/json

{ }

List audit events for a user

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403

Content type

application/json

{"property1": [{"created_at": "string",
"event_type": "string",
"id": "string",
"payload": {"property1": null,
"property2": null
},
"tenant_id": "string",
"tenant_name": "string",
"user_email": "string",
"user_id": "string"
}
],
"property2": [{"created_at": "string",
"event_type": "string",
"id": "string",
"payload": {"property1": null,
"property2": null
},
"tenant_id": "string",
"tenant_name": "string",
"user_email": "string",
"user_id": "string"
}
]
}

analytics

Ingest analytics events

Authorizations:

BearerAuth

Responses

Response samples

202
400
401

Content type

application/json

{"property1": "string",
"property2": "string"
}

Ingest public (unauthenticated) analytics events

Responses

Response samples

202
400

Content type

application/json

{"property1": "string",
"property2": "string"
}

List analytics rollups

Authorizations:

BearerAuth

Responses

Response samples

200
400
401

Content type

application/json

{"property1": [{"bucket_size_seconds": 0,
"bucket_start": "string",
"count": 0,
"element": "string",
"event_type": "string",
"route": "string",
"target": "string",
"tenant_id": "string",
"updated_at": "string",
"variant": "string"
}
],
"property2": [{"bucket_size_seconds": 0,
"bucket_start": "string",
"count": 0,
"element": "string",
"event_type": "string",
"route": "string",
"target": "string",
"tenant_id": "string",
"updated_at": "string",
"variant": "string"
}
]
}

Analytics rollup status

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"property1": [{"bucket_count": 0,
"bucket_size_seconds": 0,
"last_bucket": "string",
"last_updated": "string",
"tenant_id": "string"
}
],
"property2": [{"bucket_count": 0,
"bucket_size_seconds": 0,
"last_bucket": "string",
"last_updated": "string",
"tenant_id": "string"
}
]
}

List analytics event trails

Authorizations:

BearerAuth

Responses

Response samples

200
400
401

Content type

application/json

{"property1": [{"auto_key": "string",
"duration_ms": 0,
"element": "string",
"event_type": "string",
"id": 0,
"label": "string",
"meta": {"property1": null,
"property2": null
},
"occurred_at": "string",
"position": 0,
"route": "string",
"session_id": "string",
"target": "string",
"tenant_id": "string",
"tenant_name": "string",
"user_email": "string",
"user_id": "string",
"variant": "string"
}
],
"property2": [{"auto_key": "string",
"duration_ms": 0,
"element": "string",
"event_type": "string",
"id": 0,
"label": "string",
"meta": {"property1": null,
"property2": null
},
"occurred_at": "string",
"position": 0,
"route": "string",
"session_id": "string",
"target": "string",
"tenant_id": "string",
"tenant_name": "string",
"user_email": "string",
"user_id": "string",
"variant": "string"
}
]
}

auth

Log in and receive a JWT

Request Body schema: application/json
required

Login request

email	string
password	string
tenant_name	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string",
"tenant_name": "string"
}

Response samples

200
401

Content type

application/json

{"is_superuser": true,
"roles": ["string"
],
"tenant": {"id": "string",
"name": "string"
},
"token": "string",
"user": {"email": "string",
"id": "string"
}
}

Current session details

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"is_superuser": true,
"roles": ["string"
],
"tenant": {"id": "string",
"name": "string"
},
"token": "string",
"user": {"email": "string",
"id": "string"
}
}

Reset password

Authorizations:

BearerAuth

Request Body schema: application/json
required

Reset password request

current_password	string
new_password	string

Responses

Request samples

Payload

Content type

application/json

{"current_password": "string",
"new_password": "string"
}

Response samples

204
400
401
404
500

Content type

application/json

"string"

Create a tenant and admin account

Request Body schema: application/json
required

Signup request

email	string
password	string
tenant_name	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"password": "string",
"tenant_name": "string"
}

Response samples

201
400
500

Content type

application/json

{"is_superuser": true,
"roles": ["string"
],
"tenant": {"id": "string",
"name": "string"
},
"token": "string",
"user": {"email": "string",
"id": "string"
}
}

health

Aggregated health rollup

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"checked_at": "string",
"ok": true,
"rollup": "string",
"services": [{"active_jobs": 0,
"bucket_count": 0,
"bucket_size_seconds": 0,
"detail": "string",
"failure_rate_percent": 0,
"has_data": true,
"idle": true,
"lag_ms": 0,
"last_bucket": "string",
"last_updated": "string",
"latency_ms": 0,
"name": "string",
"queue_lag_seconds": 0,
"status": "string",
"worker_idle_seconds": 0
}
],
"severity": "string"
}

API metrics summary

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"avg_duration_ms": 0,
"completed_last_hour": 0,
"duration_p50_ms": 0,
"duration_p95_ms": 0,
"failed_last_hour": 0,
"maintenance_tasks": {"property1": {"avg_duration_ms": 0,
"failures": 0,
"successes": 0
},
"property2": {"avg_duration_ms": 0,
"failures": 0,
"successes": 0
}
},
"queue_lag_seconds": 0,
"queued_jobs": 0,
"rbac_denials_24h": 0,
"running_jobs": 0,
"succeeded_last_hour": 0,
"success_rate_percent": 0
}

Public, sanitized health snapshot

Responses

Response samples

200

Content type

application/json

{"checked_at": "string",
"ok": true,
"rollup": "string",
"services": [{"detail": "string",
"latency_ms": 0,
"name": "string",
"status": "string"
}
]
}

Public, sanitized health history

Responses

Response samples

200

Content type

application/json

[{"avg_latency_ms": 0,
"bucket_size_seconds": 0,
"bucket_start": "string",
"degraded_count": 0,
"down_count": 0,
"sample_count": 0,
"service_id": "string",
"service_name": "string",
"uptime_percent": 0
}
]

jobs

List jobs for the tenant

Authorizations:

BearerAuth

query Parameters

limit	integer Limit results (1-200)
state	string Filter by state
type	string Job type
q	string Free text search
before	string Return jobs created before ISO timestamp

Responses

Response samples

200
401

Content type

application/json

{"jobs": [{"attempt": 0,
"created_at": "string",
"created_by": "string",
"finished_at": "string",
"heartbeat_at": "string",
"id": "string",
"idempotency_key": "string",
"max_attempts": 0,
"params": null,
"result": null,
"started_at": "string",
"state": "string",
"tenant_id": "string",
"trace_id": "string",
"type": "string"
}
]
}

Create a job

Authorizations:

BearerAuth

Request Body schema: application/json
required

Job request

idempotency_key	string
job_type	string
max_attempts	integer
params	Array of integers
	object
trace_id	string

Responses

Request samples

Payload

Content type

application/json

{"idempotency_key": "string",
"job_type": "string",
"max_attempts": 0,
"params": [0
],
"secrets": {"property1": "string",
"property2": "string"
},
"trace_id": "string"
}

Response samples

202
400
401
409

Content type

application/json

{"attempt": 0,
"created_at": "string",
"created_by": "string",
"finished_at": "string",
"heartbeat_at": "string",
"id": "string",
"idempotency_key": "string",
"max_attempts": 0,
"params": null,
"result": null,
"started_at": "string",
"state": "string",
"tenant_id": "string",
"trace_id": "string",
"type": "string"
}

Stream tenant job events (SSE)

Authorizations:

BearerAuth

Responses

List configured job types

Authorizations:

BearerAuth

Responses

Response samples

200
401

Content type

application/json

{"types": ["string"
]
}

Fetch a job

Authorizations:

BearerAuth

path Parameters

jobID

required

string

Job ID

Responses

Response samples

200
401
404

Content type

application/json

{"attempt": 0,
"created_at": "string",
"created_by": "string",
"finished_at": "string",
"heartbeat_at": "string",
"id": "string",
"idempotency_key": "string",
"max_attempts": 0,
"params": null,
"result": null,
"started_at": "string",
"state": "string",
"tenant_id": "string",
"trace_id": "string",
"type": "string"
}

Cancel a job

Authorizations:

BearerAuth

path Parameters

jobID

required

string

Job ID

Responses

Response samples

202
400
401
404

Content type

application/json

{"attempt": 0,
"created_at": "string",
"created_by": "string",
"finished_at": "string",
"heartbeat_at": "string",
"id": "string",
"idempotency_key": "string",
"max_attempts": 0,
"params": null,
"result": null,
"started_at": "string",
"state": "string",
"tenant_id": "string",
"trace_id": "string",
"type": "string"
}

Stream job events (SSE)

Authorizations:

BearerAuth

path Parameters

jobID

required

string

Job ID

Responses

retention

List retention policies for a tenant

Authorizations:

BearerAuth

query Parameters

tenant_id

string

Tenant ID (superuser only; defaults to caller's tenant)

Responses

Response samples

200
401
403

Content type

application/json

{"policies": [{"allowed_windows": [0
],
"default_window_days": 0,
"domain": "string",
"effective_window_days": 0,
"override": {"tenant_id": "string",
"window_days": 0
}
}
]
}

Get a retention policy for a domain

Authorizations:

BearerAuth

path Parameters

domain

required

string

Retention domain

query Parameters

tenant_id

string

Tenant ID (superuser only; defaults to caller's tenant)

Responses

Response samples

200
400
401
403

Content type

application/json

{"property1": {"allowed_windows": [0
],
"default_window_days": 0,
"domain": "string",
"effective_window_days": 0,
"override": {"tenant_id": "string",
"window_days": 0
}
},
"property2": {"allowed_windows": [0
],
"default_window_days": 0,
"domain": "string",
"effective_window_days": 0,
"override": {"tenant_id": "string",
"window_days": 0
}
}
}

Set retention window for a domain/tenant

Authorizations:

BearerAuth

path Parameters

domain

required

string

Retention domain

query Parameters

tenant_id

string

Tenant ID (superuser only; defaults to caller's tenant)

Request Body schema: application/json
required

Desired window (allowed set from schema; 0=indefinite)

window_days

integer

Responses

Request samples

Payload

Content type

application/json

{"window_days": 0
}

Response samples

200
400
401
403

Content type

application/json

{"property1": {"allowed_windows": [0
],
"default_window_days": 0,
"domain": "string",
"effective_window_days": 0,
"override": {"tenant_id": "string",
"window_days": 0
}
},
"property2": {"allowed_windows": [0
],
"default_window_days": 0,
"domain": "string",
"effective_window_days": 0,
"override": {"tenant_id": "string",
"window_days": 0
}
}
}

Clear retention override for a domain/tenant

Authorizations:

BearerAuth

path Parameters

domain

required

string

Retention domain

query Parameters

tenant_id

string

Tenant ID (superuser only; defaults to caller's tenant)

Responses

Response samples

200
400
401
403

Content type

application/json

{"property1": {"allowed_windows": [0
],
"default_window_days": 0,
"domain": "string",
"effective_window_days": 0,
"override": {"tenant_id": "string",
"window_days": 0
}
},
"property2": {"allowed_windows": [0
],
"default_window_days": 0,
"domain": "string",
"effective_window_days": 0,
"override": {"tenant_id": "string",
"window_days": 0
}
}
}

Retention status by domain

Authorizations:

BearerAuth

Responses

Response samples

200
401
403

Content type

application/json

{"domains": [{"active": 0,
"domain": "string",
"dropped": 0,
"dropping": 0,
"eligible": 0,
"error": 0
}
]
}

users

Get user detail

Authorizations:

BearerAuth

Responses

Response samples

200
400
401
403
404

Content type

application/json

{ }

TeaLab API (0.1.0)

catalog

Get feature catalog

Authorizations:

Responses

Response samples

sessions

List all sessions (superuser)

Authorizations:

query Parameters

Responses

Response samples

List sessions for a tenant (admin)

Authorizations:

path Parameters

query Parameters

Responses

Response samples

List sessions for current user

Authorizations:

query Parameters

Responses

Response samples

Revoke a session

Authorizations:

path Parameters

Responses

Response samples

notices

List system notices

Authorizations:

query Parameters

Responses

Response samples

Create or update a system notice

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a system notice

Authorizations:

path Parameters

Responses

Response samples

List notices for a tenant

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Create or update a tenant notice

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a tenant notice

Authorizations:

path Parameters

Responses

Response samples

tenants

List tenants (superuser)

Authorizations:

Responses

Response samples

Get tenant summary (admin)

Authorizations:

path Parameters

Responses

Response samples

List tenant overrides (admin)

Authorizations:

path Parameters

query Parameters

Responses

Response samples

List role overrides for a tenant (admin)

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required