Sign in
latestOpenAPI 3.1.02026-08-18490237.4 KB

c690ac22ae04

mention

Resolve @slug capsule and Type mentions in a single round-trip

post/api/preview/mentions/resolve

Query parameters

wsstring

Optional workspace context for the request. Same value rules as the MCP workspace tool argument. Omit to use the caller's default workspace.

Optional workspace context for the request. Same value rules as the MCP workspace tool argument. Omit to use the caller's default workspace.

Request body

include_imagesboolean

Whether to inline image attachment payloads in the response.

promptstring

Free-form text containing @slug/N or @slug references to resolve.

shape'mcp' | 'wide'

Output shape. mcp = compact agent-facing projection; wide = full envelope (default).

type_capsule_limitinteger

Cap on capsules returned per resolved Type mention. 1–100; defaults server-side.

workspaceIdstring nullable

Workspace context. null = personal workspace; UUID = a specific organization workspace; omit to resolve cross-workspace. Overridden by ?ws= query param when present.

Response

Successful response

capsulesobject required
metaobject
parsedobject
projectsobject
rejectedobject nullable
typesobject required