GoodMemGoodMem
ReferenceAPIREST APIDecision Models

Get a decision model

GET /v1/decision-models/{id}: Returns the connection settings and supported features of a decision model.

Returns the connection settings and supported features of a decision model. Requires READ_DECISION_MODEL. Set includeCredentials=true to include stored credentials; this also requires READ_DECISION_MODEL_CREDENTIALS. Returns 404 if the model does not exist, or 403 if it exists but you lack permission.

GET
/v1/decision-models/{id}
x-api-key<token>

In: header

Path Parameters

idstring

UUID of the decision model

Query Parameters

includeCredentials?boolean

Include stored credentials. Requires READ_DECISION_MODEL_CREDENTIALS in addition to READ_DECISION_MODEL.

Defaultfalse

Header Parameters

GoodMem-Timeout-Ms?integer

Optional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.

Formatint64
Range1 <= value <= 86400000

Response Body

curl -X GET "https://your-goodmem-server.example.com/v1/decision-models/550e8400-e29b-41d4-a716-446655440000?includeCredentials=false" \  -H "GoodMem-Timeout-Ms: 30000"
{
  "decisionModelId": "a426a8bc-ce04-41fc-a635-cb0d9e15bae3",
  "displayName": "string",
  "description": "string",
  "providerType": "JEV",
  "endpointUrl": "string",
  "apiPath": "string",
  "modelIdentifier": "string",
  "credentials": {
    "apiKey": {
      "inlineSecret": "sk-1234567890abcdef",
      "secretRef": {
        "uri": "vault://path/to/secret"
      },
      "headerName": "Authorization",
      "prefix": "Bearer "
    },
    "gcpAdc": {
      "scopes": [
        "https://www.googleapis.com/auth/cloud-platform"
      ],
      "quotaProjectId": "my-quota-project"
    }
  },
  "configuration": {},
  "labels": {
    "property1": "string",
    "property2": "string"
  },
  "version": "string",
  "monitoringEndpoint": "string",
  "ownerId": "4d206909-730f-409a-88f6-dcfaa8fc28cc",
  "capabilities": {
    "questionTypes": [
      "string"
    ],
    "media": [
      {
        "kind": "IMAGE",
        "mimeTypes": [
          "string"
        ],
        "placements": [
          "string"
        ],
        "limits": [
          {
            "type": "MAX_ITEMS",
            "value": 0
          }
        ]
      }
    ],
    "limits": [
      {
        "type": "MAX_QUESTIONS",
        "value": 0
      }
    ],
    "contextBoundLimits": [
      "string"
    ],
    "semantics": [
      {
        "questionType": "CHOICE",
        "confidence": "ADJUSTED_TOP_PROBABILITY",
        "output": "CANDIDATE_IDENTIFIER"
      }
    ],
    "inputOverflow": "REJECTS"
  },
  "createdAt": 0,
  "updatedAt": 0,
  "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",
  "updatedById": "d8bc6076-4141-4a88-80b9-0eb31643066f"
}
Empty
Empty
Empty
Empty
Empty
Empty
Empty
Empty