Resolve runtime tenant DTO for a top-level partner app

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
GET /v1/internal/tenants/{platform}/{org_slug}

Resolve the published runtime DTO for a top-level partner app.

Args: platform: Target LLM platform (chatgpt | claude | copilot | gemini). org_slug: Top-level partner app slug.

Returns: Runtime DTO matching runtime-tenant-dto.v1.schema.json. The ETag HTTP header is set to the snapshot's ETag.

Path parameters

  • platform string Required
  • org_slug string Required

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • partner_app_id string Required
    • parent_partner_app_id string | null
    • platform string Required

      Values are chatgpt, claude, copilot, or gemini.

    • org_slug string Required

      Minimum length is 1, maximum length is 64.

    • org_id string Required

      Minimum length is 1, maximum length is 64.

    • brand_slug string | null

      Minimum length is 1, maximum length is 64.

    • schema_version integer Required

      Minimum value is 1.0.

    • version integer Required

      Minimum value is 1.0.

    • status string | null

      Value is PUBLISHED.

    • display_name string | null

      Minimum length is 1, maximum length is 120.

    • auth_config object Required

      Any of:
    • sections array[object]

      Not more than 50 elements.

      Hide sections attributes Show sections attributes object

      Runtime shape — capability, layout, and tool are required.

      • id string Required

        Minimum length is 1, maximum length is 64.

      • capability string Required
      • title string | null
      • description string | null
      • layout string Required
      • enabled boolean | null
      • filters object | null

        Additional properties are allowed.

      • ui object | null

        Additional properties are NOT allowed.

        Hide ui attributes Show ui attributes object | null
        • empty_state_title string | null

          Maximum length is 120.

        • empty_state_body string | null

          Maximum length is 500.

        • max_items integer | null

          Minimum value is 1.0, maximum value is 100.0.

        • sort string | null

          Values are relevance, price_asc, price_desc, newest, or rating.

      • tool object Required

        Runtime tool descriptor. name and description required.

        Additional properties are NOT allowed.

        Hide tool attributes Show tool attributes object
        • name string Required
        • description string Required

          Minimum length is 1, maximum length is 1024.

        • output_template_uri string | null

          Maximum length is 256.

      • sponsored_ranking_surface string | null

        Values are primary, embedded, or none.

    • theme object Required

      Resolved theme. Brand inheritance is pre-applied by the resolver.

      Additional properties are NOT allowed.

      Hide theme attributes Show theme attributes object
      • brand_name string Required

        Minimum length is 1, maximum length is 120.

      • logo_url string | null
      • color_scheme string Required

        Values are light, dark, or system.

      • colors object Required

        Runtime shape — primary is required.

        Additional properties are NOT allowed.

        Hide colors attributes Show colors attributes object
        • primary string Required
        • accent string | null
        • background string | null
        • surface string | null
        • text string | null
        • muted_text string | null
        • border string | null
      • typography object | null

        Runtime typography shape. Runtime currently has no required fields.

        Additional properties are NOT allowed.

        Hide typography attributes Show typography attributes object | null
        • font_family string | null

          Values are system, inter, ibm-plex, dm-sans, geist, instrument-serif, fraunces, or space-grotesk.

        • heading_weight integer | null
        • body_weight integer | null
      • radius string | null

        Values are none, sm, md, lg, or pill.

    • sponsored_config object Required

      Any of:
    • catalog_id string Required
    • etag string Required

      Minimum length is 1, maximum length is 160.

    • expires_at string(date-time) Required
    • resolved_at string(date-time) | null
    • cache object | null

      Additional properties are NOT allowed.

      Hide cache attributes Show cache attributes object | null
      • ttl_seconds integer Required

        Minimum value is 0.0, maximum value is 3600.0.

      • stale_while_revalidate_seconds integer Required

        Minimum value is 0.0, maximum value is 86400.0.

      • suspension_ttl_seconds integer | null

        Minimum value is 0.0, maximum value is 300.0.

  • 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
GET /v1/internal/tenants/{platform}/{org_slug}
curl \
 --request GET 'http://api.example.com/v1/internal/tenants/{platform}/{org_slug}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "partner_app_id": "string",
  "parent_partner_app_id": "string",
  "platform": "chatgpt",
  "org_slug": "string",
  "org_id": "string",
  "brand_slug": "string",
  "schema_version": 42,
  "version": 42,
  "status": "PUBLISHED",
  "display_name": "string",
  "auth_config": {
    "mode": "public"
  },
  "sections": [
    {
      "id": "string",
      "capability": "string",
      "title": "string",
      "description": "string",
      "layout": "string",
      "enabled": true,
      "filters": {},
      "ui": {
        "empty_state_title": "string",
        "empty_state_body": "string",
        "max_items": 42,
        "sort": "relevance"
      },
      "tool": {
        "name": "string",
        "description": "string",
        "output_template_uri": "string"
      },
      "sponsored_ranking_surface": "primary"
    }
  ],
  "theme": {
    "brand_name": "string",
    "logo_url": "string",
    "color_scheme": "light",
    "colors": {
      "primary": "string",
      "accent": "string",
      "background": "string",
      "surface": "string",
      "text": "string",
      "muted_text": "string",
      "border": "string"
    },
    "typography": {
      "font_family": "system",
      "heading_weight": 42,
      "body_weight": 42
    },
    "radius": "none"
  },
  "sponsored_config": {
    "enabled": false,
    "adapter": "none"
  },
  "catalog_id": "string",
  "etag": "string",
  "expires_at": "2026-05-04T09:42:00Z",
  "resolved_at": "2026-05-04T09:42:00Z",
  "cache": {
    "ttl_seconds": 42,
    "stale_while_revalidate_seconds": 42,
    "suspension_ttl_seconds": 42
  }
}
Response examples (422)
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "ctx": {}
    }
  ]
}