/api/v1/match-score/calculate

POST

/api/v1/match-score/calculate

curl --request POST \
  --url https://dpg.example.com/api/v1/match-score/calculate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "itemA": { "item_network": "example", "item_domain": "example", "item_type": "example", "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "item_instance_url": "example", "item_schema_url": "example", "item_state": { "additionalProperty": "example" }, "lifecycle_status": "draft", "item_latitude": 1, "item_longitude": 1 }, "itemB": { "item_network": "example", "item_domain": "example", "item_type": "example", "item_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "item_instance_url": "example", "item_schema_url": "example", "item_state": { "additionalProperty": "example" }, "lifecycle_status": "draft", "item_latitude": 1, "item_longitude": 1 } }'

• Your deployment's public host (set per network instance)
• Local development

Authorizations

• apiKeyAuth
• sessionAuth

Request Body^required

Media typeapplication/json

object

itemA

required

object

item_network

required

string

item_domain

required

string

item_type

required

string

item_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

item_instance_url

required

string

item_schema_url

required

string

item_state

required

Any of:

unknown

Any of:

string

string

number

number

boolean

boolean

string

string

nullable

object

object

key

additional properties

Array

Array

lifecycle_status

string

Allowed values: draft live paused

item_latitude

number

nullable >= -90 <= 90

item_longitude

number

nullable >= -180 <= 180

itemB

required

object

item_network

required

string

item_domain

required

string

item_type

required

string

item_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

item_instance_url

required

string

item_schema_url

required

string

item_state

required

Any of:

unknown

Any of:

string

string

number

number

boolean

boolean

string

string

nullable

object

object

key

additional properties

Array

Array

lifecycle_status

string

Allowed values: draft live paused

item_latitude

number

nullable >= -90 <= 90

item_longitude

number

nullable >= -180 <= 180

Responses

200

Default Response

Media typeapplication/json

object

provider

required

string

>= 1 characters

score

number

band

string

>= 1 characters

confidence

number

version

string

>= 1 characters

prompt_version

string

>= 1 characters

model_provider

string

>= 1 characters

model

string

>= 1 characters

reasoning

string

>= 1 characters

signals

Array<object>

object

name

required

string

>= 1 characters

impact

required

string

>= 1 characters

summary

required

string

>= 1 characters

raw_response

required

Example^generated

{
  "provider": "example",
  "score": 1,
  "band": "example",
  "confidence": 1,
  "version": "example",
  "prompt_version": "example",
  "model_provider": "example",
  "model": "example",
  "reasoning": "example",
  "signals": [
    {
      "name": "example",
      "impact": "example",
      "summary": "example"
    }
  ],
  "raw_response": "example"
}

502

Default Response

Media typeapplication/json

object

error

required

string

>= 1 characters

message

required

string

>= 1 characters

Example^generated

{
  "error": "example",
  "message": "example"
}

503

Default Response

Media typeapplication/json

object

error

required

string

>= 1 characters

message

required

string

>= 1 characters

Example^generated

{
  "error": "example",
  "message": "example"
}