Skip to main content
Get the task-based match score between two task sets

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

response_format
enum<string>
default:simple

If set to explained, the response will include an explanation of the match.

Available options:
simple,
explained
Example:

"explained"

Body

application/json

A pair of task sets to compare. Both sides are explicit lists of existing tasks, each optionally weighted by weekly hours; the match score is computed directly from their task embeddings.

source_tasks
object[]
required

Source task set. Must contain between 1 and 100 tasks; every task_id must reference an existing Task in the system.

Required array length: 1 - 100 elements
Example:
target_tasks
object[]
required

Target task set. Must contain between 1 and 100 tasks; every task_id must reference an existing Task in the system.

Required array length: 1 - 100 elements
Example:

Response

OK

An ad-hoc task-based match result between two task sets.

score
number<float>
required

The symmetric task-based match score between the two task sets, expressed as a number between 0 and 1.

Required range: 0 <= x <= 1
Example:

0.42