# AI conversation message

This feature is currently in private beta. [Contact us](mailto:support@pushsecurity.com) for more information.

Endpoint: POST ai-conversation-message
Version: v1
Security: X-Signature

## Security:

  - `X-Signature` (unknown)
    http bearer

## Header parameters:

  - `X-Signature` (string, required)

## Request body:

  - `application/json` (unknown)
    A prompt or response was observed in a conversation with an AI application.

## Request fields (application/json):

  - `version` (string)
    The version of the event.
    Example: 1

  - `id` (string)
    The unique identifier for the event. This can be used as an idempotency key.
    Example: c478966c-f927-411c-b919-179832d3d50c

  - `tenantId` (string)
    The unique identifier of the tenant the event belongs to.
    Example: 4f9d2e7a-1b3c-4d5e-8f6a-7c8b9d0e1f2a

  - `tenantMetadata` (object)
    Key/value metadata set by the partner that manages this tenant.
Only present for tenants managed by a partner. When a partner manages the tenant but has set no metadata, it is present as an empty object rather than omitted or null.
A partner may set at most 10 entries, with keys up to 40 characters and values up to 256 characters.
    Example: {"customerRef":"ACME-001","region":"emea"}

  - `timestamp` (integer)
    When the event occurred, formatted as a UNIX timestamp (in seconds).
    Example: 1698604061

  - `category` (string)
    The category of the event.
    Enum: "ACTIVITY"

  - `description` (string)
    The description of the event. Note: this is subject to change and should not be used to match on this object.
    Example: user@example.com sent a prompt to OPENAI_CHATGPT

  - `object` (string)
    The object that was created.
    Enum: "AI_CONVERSATION_MESSAGE"

  - `friendlyName` (string)
    The friendly name of this object. Note: this is subject to change and should not be used to match on this object.
    Example: AI conversation message

  - `new` (object)
    This object represents a prompt or response observed in a conversation with an AI application.

  - `new.sourceIpAddress` (string)
    The IP address of the user who sent or received the message.
    Example: 8.158.25.38

  - `new.os` (string)
    The OS used by the employee
    Enum: "MACOS", "WINDOWS", "LINUX", "CHROME_OS", "IOS", "ANDROID", "UNKNOWN"

  - `new.userAgent` (string)
    The user agent string reported by the browser.
    Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36 Edge/16.16299

  - `new.employee` (object)
    This object represents an employee in your organization.

  - `new.employee.id` (string)
    Unique identifier for the employee
    Example: 2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0

  - `new.employee.email` (string)
    Primary email address of the employee
    Example: john.hill@example.com

  - `new.employee.firstName` (string)
    First name of the employee
    Example: John

  - `new.employee.lastName` (string)
    Last name of the employee
    Example: Hill

  - `new.employee.department` (string)
    Department - as provided by connected API integrations
    Example: Security Engineering

  - `new.employee.location` (string)
    Location - as provided by connected API integrations
    Example: New York

  - `new.employee.licensed` (boolean)
    Whether the employee is licensed on the Push platform
    Example: true

  - `new.employee.chatopsEnabled` (boolean)
    Whether the employee has ChatOps enabledDeprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version.
    Example: true

  - `new.employee.creationTimestamp` (integer)
    When this employee was created, formatted as a UNIX timestamp (in seconds)
    Example: 1698669223

  - `new.browser` (string)
    The browser used by the employee
    Enum: "CHROME", "FIREFOX", "EDGE", "SAFARI", "OPERA", "BRAVE", "ARC", "ISLAND", "PRISMA_ACCESS", "ATLAS", "COMET", "DIA", "UNKNOWN"

  - `new.conversationId` (string)
    Unique identifier of the conversation the message belongs to.
    Example: c478966c-f927-411c-b919-179832d3d50c

  - `new.appTenantId` (string)
    Identifier of the tenant generated by the AI platform. Null if it could not be determined.
    Example: 4f9d2e7a-1b3c-4d5e-8f6a-7c8b9d0e1f2a

  - `new.conversationStartTimestamp` (integer)
    When the first prompt in the conversation occurred, formatted as a UNIX timestamp (in seconds).
    Example: 1698604061

  - `new.messageType` (string)
    Whether the captured message is a user prompt or an AI response.
    Enum: "PROMPT", "RESPONSE"

  - `new.appType` (string)
    The AI application the conversation message was observed on.
    Enum: "OPENAI_CHATGPT", "ANTHROPIC_CLAUDE", "MICROSOFT_COPILOT", "DEEPSEEK", "GOOGLE_GEMINI", "GROK"

  - `new.url` (string)
    URL of the tab where the message was observed.
    Example: https://chatgpt.com/

  - `new.email` (string)
    The identity signed into the AI application. Null if the user was unauthenticated.
    Example: john.hill@example.com

  - `new.content` (string)
    The prompt or response text, truncated to 100 KB.
    Example: Summarise the attached document.

  - `new.timestamp` (integer)
    When the message was observed, formatted as a UNIX timestamp (in seconds).
    Example: 1698604061

## Response 2XX:

  - `2XX` (unknown)
    Return any 2XX status to indicate that the data was received successfully

