Skip to content

Parse Task text

POST
/api/v1/notes/tasks/parse
curl --request POST \
--url https://example.com/api/v1/notes/tasks/parse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "text": "example" }'

Requires a signed-in User with the data scope. It returns Task fields from text without saving a Task. It returns 400 when the text is invalid. Route: /api/v1/notes/tasks/parse. Inputs: . Do not automatically replay this operation after an uncertain result.

Media typeapplication/json
object
text
required
string
Examplegenerated
{
"text": "example"
}
Media typeapplication/json
object
confidence
required
string
diagnostics
required
Array<string>
due
string | null
margin
required
integer format: int32
priority
string | null
recurrence
string | null
scheduled
string | null
start
string | null
suggested_mode
required
string
tags
required
Array<string>
title
required
string
Examplegenerated
{
"confidence": "example",
"diagnostics": [
"example"
],
"due": "example",
"margin": 1,
"priority": "example",
"recurrence": "example",
"scheduled": "example",
"start": "example",
"suggested_mode": "example",
"tags": [
"example"
],
"title": "example"
}