Sign in
Services

Get a single service by id, e.g. "image/flux2/klein/createImage/9b", with its bucketed history over the window.

Changed on
get/v2/services/{serviceId}

Request

  • The document declares no server URL.
  • Auth: none required

Path parameters

serviceIdstring required

The service id.

Query parameters

windowstring

Window the summary metrics and history cover: 1h, 24h or 7d.

intervalstring

History bucket size: 5m, 1h or 1d.

Response

OK

idstring required

Variable-depth path, e.g. "image/flux2/klein/createImage/9b". Opaque: read Civitai.Orchestration.Api.Controllers.v2.Consumers.Services.ServiceResponse.Parameters rather than splitting this on "/", as the depth and the meaning of each segment differ per engine.

categorystring required

The id's first segment.

parametersobject required

The id decomposed, e.g. { engine: flux2, model: klein, operation: createImage }.

stepstring nullable

The workflow step $type this service is reached through.

submitstring nullable

Where to submit this service.

estimatestring nullable

Returns the exact cost of a given input without running it.

namestring nullable
descriptionstring nullable
tagsstring[] required
strengthsstring nullable
weaknessesstring nullable
releasedAtstring date-time nullable
status'unknown' | 'available' | 'degraded' | 'unavailable' required

Changes