Skip to main content
GET
Get a container service by slug (runtime)

Authorizations

Authorization
string
header
required

User session JWT (Bearer ). Must be paired with the X-Team-ID request header on team-scoped endpoints so the server knows which team's resources to operate on.

Headers

X-Team-ID
string<uuid>

UUID of the team to scope the request to. Used by dual-auth endpoints (runtime + scoped management):

  • JWT callers MUST send it — a user may belong to multiple teams and the runtime cannot otherwise know which one to operate on. Missing header → 400.
  • Credential callers (sk-, dk-) can omit it because the team is derived from the credential row itself. Any value sent is ignored.
Example:

"019abc12-4567-7890-abcd-ef1234567891"

Path Parameters

serviceSlug
string
required

Response

Service detail

id
string<uuid>
required
service_slug
string
required
display_name
string
required
service_type
enum<string>
required

Whether the workload runs on a team agent's docker bridge or on external infrastructure.

Available options:
deployed,
external
service_status
enum<string>
required
Available options:
created,
deploying,
running,
stopping,
stopped,
failed
created_at
string<date-time>
required
updated_at
string<date-time>
required
service_desc
string
docker_image
string
exposed_port
integer
health_path
string
env_config
object[]
volume_config
object[]
required_labels
string[]
gpu_count
integer

GPU count: -1=all GPUs, 0=none, N=specific count

replica_count
integer
usage_prompt
string

AI-facing description. Readable by anyone who can list/read services in the team — do not put secrets here.

openapi_url
string

Optional OpenAPI document path served by the container.

external_url
string<uri>

Absolute https:// URL — populated only when service_type=external.

Pattern: ^https://
external_auth_credential_id
string<uuid>

Credential vault reference used to authenticate outbound requests — populated only when service_type=external.