Ticket API

Unusual Suite exposes an HTTP REST API that accepts support requests and returns AI-generated responses in JSON format.

Set Up API Access

1. Configure an Unusual Suite user who has write access to Ticket records.
2. Assign an API key to that user in the user interface.
3. Copy the API key to the clipboard.

Send a Request

1. Send an HTTP POST request to https://ds-01.unusual-suite.com/open-api/ticket/compose-response.
2. Include a request header with the key api-key set to the API key from the setup step above.
3. Set the request body to one of the following:
   • The ticket query as plain text, Markdown, or HTML.
   • A JSON object (see structure below) if you need to include attachments.
4. Wait for the response — Unusual Suite typically replies within seconds, but it may take up to a minute.

Request Body Format (with Attachments)

When sending attachments, use this JSON structure:

{
  "text": "<the ticket text as plain text, markdown text or HTML>",
  "attachments": [       // attachments are optional
    {                   // one or more attachment objects may be provided
      "name": "<the attachment name; the file extension is important and must be provided>",
      "content": "<the attachment content as plain text or as base64 encoded binary string>"
    }
  ]
}

Response Format

Unusual Suite returns a JSON object. Some properties are omitted from this example as they are not relevant for most integrations:

{
  "text": "<response in markdown format>",
  "text-html": "<response in HTML format>"
}