Skip to main content
POST
/
v1
/
chat
/
{chatConversationShortId}
Send chat message
curl --request POST \
  --url https://api.qa.tech/v1/chat/{chatConversationShortId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "applicationOverrides": [
    {
      "applicationShortId": "<string>",
      "environment": {
        "url": "<string>",
        "name": "<string>"
      },
      "devicePresetShortId": "<string>"
    }
  ],
  "projectShortId": "<string>"
}
'
{
  "shortId": "<string>",
  "url": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "messages": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "text": "<string>",
      "isStreaming": true
    }
  ]
}

Path Parameters

​
chatConversationShortId
string
required
Pattern: ^chat(-.+_.+|_.+)$

Body

application/json

Request body for sending a chat message

​
message
string
required

The message text to send. Example: 'Generate a login flow test for staging'.

Minimum string length: 1
​
applicationOverrides
object[]

Optional per-application environment overrides to apply for this conversation.

​
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

202 - application/json

The request has been accepted for processing, but processing has not yet completed.

Conversation data with recent messages (newest first).

​
shortId
string
required
Pattern: ^chat(-.+_.+|_.+)$
​
url
string
required

Dashboard URL for the conversation.

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
title
string
​
source
enum<string>

Where the conversation originated. api for conversations created via this API, ui for the dashboard, github/gitlab for VCS-triggered chats, and system for everything else.

Available options:
api,
ui,
github,
gitlab,
system
​
messages
object[]

Recent messages, newest first. Empty on creation; poll GET /chat/{chatConversationShortId} to retrieve.