Create credit engine configuration

POST

/v1/flows/{flowId}/credit-engine-config

Creates the credit engine configuration for a flow, linking it to a previously registered Taktile policy (policyId) and defining the input (input[]) and output (output[]) mappings.

Unlike the decision engine configuration, this endpoint REQUIRES the fields title (string), description (string) and hasValue (boolean) at the root level of the payload, both on create and on update — missing any of them returns a 400 error.

The keys (key) used in input[] and output[].segments[].fields[] must match exactly the keys declared by the Taktile policy at registration time. The native fields score, rating and value are computed automatically by the engine at runtime and must NOT be included in output[].segments[].fields[] — only the criteria defined by the policy.

Fields under output[].segments[].fields[] do not have a path — only aggregates[] items, when present, have a path, pointing to the source of each aggregated value.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Configuration created

application/json

The credit engine configuration was created successfully.

Bodyapplication/json

🟠400Invalid payload

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//credit-engine-config' \
--header 'Content-Type: application/json' \
--data '{
    "companyId": "string",
    "title": "string",
    "description": "string",
    "hasValue": true,
    "policyId": "string",
    "input": [
        {
            "key": "string",
            "title": "string",
            "type": "string",
            "path": "string",
            "reference": "string",
            "required": true,
            "description": "string"
        }
    ],
    "output": [
        {
            "description": "string",
            "segments": [
                {
                    "description": "string",
                    "fields": [
                        {
                            "key": "string",
                            "title": "string",
                            "description": "string",
                            "type": "string",
                            "weight": 0,
                            "aggregates": [
                                {
                                    "key": "string",
                                    "path": "string",
                                    "description": "string"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "policyId": "string",
    "companyId": "string",
    "title": "string",
    "description": "string",
    "hasValue": true,
    "input": [
        {}
    ],
    "output": [
        {}
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Get credit engine configuration detail

Próxima página

List flow credit engine configurations