Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
relevance

Relevance score between two indexed items

POST
/v1/relevance
curl --request POST \
  --url https://search.example.com/v1/relevance \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "source": { "network": "example", "domain": "example", "type": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "target": { "network": "example", "domain": "example", "type": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

Computes how relevant two items are to each other as a percentage (0–100), from the cosine similarity of their stored embeddings. source→target (network + domain) must be an allowed interaction (interaction matrix, cross-network included), and both items must be live + indexed with embeddings from the same model version. Score only — no band/confidence/reasoning.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
source
required
object
network
required
string
>= 1 characters
domain
required
string
>= 1 characters
type
required
string
>= 1 characters
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$/
target
required
object
network
required
string
>= 1 characters
domain
required
string
>= 1 characters
type
required
string
>= 1 characters
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$/
Examplegenerated
{
  "source": {
    "network": "example",
    "domain": "example",
    "type": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  },
  "target": {
    "network": "example",
    "domain": "example",
    "type": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
score
required
number
Examplegenerated
{
  "score": 1
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
error
required
string
message
required
string
Examplegenerated
{
  "error": "example",
  "message": "example"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
string
message
required
string
Examplegenerated
{
  "error": "example",
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
string
message
required
string
Examplegenerated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
error
required
string
message
required
string
Examplegenerated
{
  "error": "example",
  "message": "example"
}

409

Section titled “409”

Default Response

Media typeapplication/json
object
error
required
string
message
required
string
Examplegenerated
{
  "error": "example",
  "message": "example"
}