List post-processing services and their names

Use this endpoint to find the name of a service referenced by a service job. The serviceId in a service job is the id of a post-processing service.

GET/service

Authorization

AuthorizationAPI key · headerrequired

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

Query parameters

idstring

Service id, such as the serviceId returned by a service job.

namestring

Exact service name.

customIdstring

Exact custom id.

ppsSidstring

Exact post-processing service SID.

Responses

200

OK.

Array of Pps

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

idqueryService id, such as the `serviceId` returned by a service job.namequeryExact service name.customIdqueryExact custom id.ppsSidqueryExact post-processing service SID.

Request

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

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

import requests

response = requests.get(
    "https://next.amfg.ai/engine-service/public-api/v1/service",
    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"
}