---
title: "Ask authenticated posterly Support AI"
method: POST
path: "/api/v1/support/chat"
tags: ["Support"]
---

# Ask authenticated posterly Support AI

`POST /api/v1/support/chat`

## Request

- Base URL: `https://www.poster.ly`
- URL: `https://www.poster.ly/api/v1/support/chat`
- Auth: HTTP bearer

Ask posterly Support AI a docs-backed question with read-only account/post diagnostics for the caller workspace. This is not a public endpoint: API-key callers need `posts:read` and `accounts:read` scopes, and hosted/Web MCP callers must be authenticated. Human tickets are never opened on the first answer; ticket creation requires a follow-up in a continued conversation that already has an assistant answer, plus `request_human: true` and `confirm_escalation: true` after explicit user confirmation.

## Request body

- union
  - object
    - `question` string, required
    - `message` string
    - `workspace_id` string: Workspace to inspect. Omit to use the API-key scoped workspace or personal workspace.
    - `conversation_id` string: Continue a previous support conversation.
    - `page_url` string: Optional posterly page URL for context.
    - `post_id` integer: Optional post ID to inspect directly.
    - `referenced_post_ids` integer[]: Optional post IDs to include in read-only diagnostics.
    - `request_human` boolean: Ask for human review. Does not create a ticket unless this is a follow-up in a conversation that already has an assistant answer and confirm_escalation is also true.
    - `confirm_escalation` boolean: Must be true after explicit user confirmation that the previous assistant answer did not solve the issue.
  - object
    - `question` string
    - `message` string, required
    - `workspace_id` string: Workspace to inspect. Omit to use the API-key scoped workspace or personal workspace.
    - `conversation_id` string: Continue a previous support conversation.
    - `page_url` string: Optional posterly page URL for context.
    - `post_id` integer: Optional post ID to inspect directly.
    - `referenced_post_ids` integer[]: Optional post IDs to include in read-only diagnostics.
    - `request_human` boolean: Ask for human review. Does not create a ticket unless this is a follow-up in a conversation that already has an assistant answer and confirm_escalation is also true.
    - `confirm_escalation` boolean: Must be true after explicit user confirmation that the previous assistant answer did not solve the issue.

## Response `200`

Support answer generated successfully

- SupportChatResponse
  - `success` boolean, required
  - `workspace_id` string, required
  - `conversation` object, required
    - `id` string, required
    - `status` string, required
    - `title` string, nullable
  - `message` object, required
    - `id` string, required
    - `role` string, required
    - `content` string, required
    - `citations` object[]
    - `created_at` string, required
  - `ticket` object, nullable
    - `id` string
    - `status` string
    - `priority` string
    - `created` boolean
  - `support_access` object
    - `can_use_human_support` boolean
    - `gated_escalation` boolean
    - `upgrade_required` boolean
    - `recommended_escalation` boolean
    - `confirmation_required` boolean
    - `ticket_created` boolean
  - `confidence` number
  - `docs_confidence` 'high' | 'medium' | 'low'
  - `needs_human` boolean
  - `escalation_reason` string, nullable
  - `model` object

## Other responses

- `400`: Validation error
- `401`: Invalid or missing API key
- `403`: Request is authenticated but not allowed
- `429`: Too many requests

---

[API](https://skmtc.dev/poster/apis/posterly-api.md) · [All operations](https://skmtc.dev/poster/apis/posterly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/poster/apis/posterly-api/revisions/60be02a61f95?raw)