Get a post-processing service and its name

Pass the serviceId returned by a service job as {id}. The name in the response is the service name. In a worker script, use engine.serviceRetrieve(serviceId).name.

GET/service/{id}

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Path parameters

idstringrequired

Responses

200

OK.

idstring

PPS ID (read-only)

appIdstring

Application ID (read-only)

namestring

PPS name (read-only)

customIdstring

Custom ID (read-only)

descriptionstring

PPS description

ppsSidstring

PPS SID (read-only)

createdAtstring

Creation date (ISO date, autoassigned, read-only)

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*

Request

curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/service/string' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/service/string", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://next.amfg.ai/engine-service/public-api/v1/service/string",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "id": "string",
  "appId": "string",
  "name": "string",
  "customId": "string",
  "description": "string",
  "ppsSid": "string",
  "createdAt": "string"
}

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}