get_ai_chat¶

ArtificialIntelligenceApi.get_ai_chat(chat_id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get chat details

Returns ChatId, Title, CreationTime, CreatedBy, Keywords, AccessType, and Summary, SummaryGenerationStatus, and Files when present. Files include SyncStatus when enrichment runs. Requires at least read-only access. Code-generator chats (chat_id starts with {user_id}-) use job access instead of chat ACL. No query parameters. No request body.

Parameters:

chat_id (str) – Unique identifier of the chat. (required)
role_id (str) – Amorphic role ID of the requesting user. Must be a role the authenticated user belongs to. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ChatDetailsResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /ai/playground/chats/{chat_id}

Parameter examples¶

Name	In	Example
`chat_id`	path	`"123e4567-e89b-12d3-a456-426614174000"`
`role_id`	header	`"custom-role-123e4567-e89b-12d3-a456-426614174000"`

Success (HTTP 200)¶

Chat details for the allowed field set.

Request / response example

{
  "ChatId": "123e4567-e89b-12d3-a456-426614174000",
  "Title": "Untitled Chat",
  "CreationTime": "2026-08-19 10:00:00",
  "CreatedBy": "jdoe",
  "AccessType": "owner",
  "Keywords": [
    "sales"
  ],
  "Summary": "Discussion of Q2 sales highlights.",
  "SummaryGenerationStatus": "completed",
  "Files": [
    {
      "FileName": "quarterly_report.pdf",
      "FileSize": 204800,
      "FileType": "pdf",
      "UploadTime": "2026-08-19 10:02:00",
      "SyncStatus": "NOT_INDEXED",
      "LastSyncedTime": "",
      "LastSyncedStatus": "N/A"
    }
  ]
}

Errors¶

Documented error codes: IPV-1002, AUTH-1012, AUTH-1001, AUTH-1011, GE-1008, DB-1002.

HTTP 400

Input validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: IPV-1002 (chat not found), AUTH-1012 (insufficient access), AUTH-1001 (missing role_id), AUTH-1011 (caller not authorized).

Missing role_id header

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

Caller not authorized

{
  "Message": "AUTH-1011 - User does not have sufficient permission to perform this action"
}

Chat not found

{
  "Message": "IPV-1002 - Invalid ChatId - 123e4567-e89b-12d3-a456-426614174000, resource not found."
}

HTTP 500

Backend failure. Body is {“Message”: “<CODE> - <text>”}. Codes: GE-1008 (unexpected backend failure), DB-1002 (persistence failure).

Unexpected backend failure

{
  "Message": "GE-1008 - Could not complete the request. Please try again."
}