Skip to main content
POST
/
api
/
v1
/
context
/
links
curl --request POST \
  --url https://api.staging.getmodus.com/api/v1/context/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/blog/post"
}
'
{
  "contextItemId": "7a3f9d2c-1111-4000-a000-000000000abc",
  "kind": "note",
  "s3Key": "context_notes/7a3f9d2c.../Q3_churn_analysis.md",
  "title": "Q3 churn analysis"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
url
string
required

URL to extract content from. Invoked via Tavily.

Example:

"https://example.com/blog/post"

​
title
string

Optional title override. When omitted, Tavily-derived metadata or the URL hostname is used.

Example:

"Example blog post"

​
isCrawl
boolean
default:false

When true, crawls multiple pages starting from the supplied URL.

Example:

false

​
pageLimit
number

Maximum number of pages to crawl when isCrawl is true. Ignored otherwise.

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

10

Response

​
contextItemId
string
required

UUID of the newly-created context item. Use it on subsequent GET / PATCH / DELETE calls.

Example:

"7a3f9d2c-1111-4000-a000-000000000abc"

​
kind
enum<string>
required

Kind of context item created.

Available options:
note,
saved_query,
link,
dimension,
fact,
metric,
filter
Example:

"note"

​
s3Key
string | null

Tenant S3 key for the raw content blob (notes, saved queries, links). Null for kinds without S3 backing.

Example:

"context_notes/7a3f9d2c.../Q3_churn_analysis.md"

​
title
string | null

Resolved title for the created item. Null for kinds without a title field.

Example:

"Q3 churn analysis"