Invoke Internal Experience

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.thankly.ai/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"Thankly MCP server": {
  "url": "https://docs.thankly.ai/mcp"
}
Close
POST /v1/internal/experiences/{capability}/invoke
Http bearer

Path parameters

  • capability string Required
application/json

Body Required

  • partner_context object Required

    Per-tenant context passed in the invoke body.

    The gateway resolves a runtime tenant DTO upstream and injects this block; the main-api then trusts it as authenticated context.

    Additional properties are NOT allowed.

    Hide partner_context attributes Show partner_context attributes object
    • org_id string Required
    • partner_app_id string Required
    • brand_slug string | null
    • catalog_id string Required
  • section_context object Required

    Section metadata for ranking + UI hints.

    Additional properties are NOT allowed.

    Hide section_context attributes Show section_context attributes object
    • section_id string Required
    • layout string

      Default value is grid.

    • max_items integer | null

      Minimum value is 1.0, maximum value is 50.0.

    • filter object | null

      Additional properties are allowed.

  • input object

    Additional properties are allowed.

  • placement string

    Default value is chatgpt.

  • session_id string | null
  • refinement object | null

    Additional properties are allowed.

  • idempotency_key string Required

    Minimum length is 1.

  • visitor_id string | null
  • preview boolean

    Default value is false.

Responses

  • 200 application/json

    Successful Response

    Additional properties are allowed.
  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
      • loc array[string | integer] Required
      • msg string Required
      • type string Required
      • input
      • ctx object
POST /v1/internal/experiences/{capability}/invoke 
curl \
 --request POST 'http://api.example.com/v1/internal/experiences/{capability}/invoke' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"partner_context":{"org_id":"string","partner_app_id":"string","brand_slug":"string","catalog_id":"string"},"section_context":{"section_id":"string","layout":"grid","max_items":42,"filter":{}},"input":{},"placement":"chatgpt","session_id":"string","refinement":{},"idempotency_key":"string","visitor_id":"string","preview":false}'
Request examples 
{
  "partner_context": {
    "org_id": "string",
    "partner_app_id": "string",
    "brand_slug": "string",
    "catalog_id": "string"
  },
  "section_context": {
    "section_id": "string",
    "layout": "grid",
    "max_items": 42,
    "filter": {}
  },
  "input": {},
  "placement": "chatgpt",
  "session_id": "string",
  "refinement": {},
  "idempotency_key": "string",
  "visitor_id": "string",
  "preview": false
}
Response examples (200) 
{}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "ctx": {}
    }
  ]
}