Scale API | Chat Threads › Messages › Patch Chat Thread Entry

Chat Threads

chat_threads

Methods

Delete Chat Thread -> unknown

delete/v4/threads/{thread_id}

Delete Chat Thread

Patch Chat Thread ->

ChatThread

patch/v4/threads/{thread_id}

Patch Chat Thread

Chat Threads

Messages

chat_threads.messages

Methods

Get Thread Messages ->

ChatThreadHistory

get/v4/threads/{thread_id}/messages

Get Thread Messages

Patch Chat Thread Entry -> { id, aggregated, application_spec_id, 10 more... }

patch/v4/threads/{thread_id}/messages/{application_interaction_id}

Patch Chat Thread Entry

Security

API Key Header

Example: x-api-key: My API Key

Parameters

thread_id: string

application_interaction_id: string

fetch_by_account: boolean

Optional

Fetch the thread by account instead of user

Response fields

id: string

aggregated: boolean

Boolean of whether this interaction has been uploaded to s3 bucket yet, default is false

application_spec_id: string

application_variant_id: string

created_at: string

The date and time when the entity was created in ISO format.

duration_ms: number

How much time the step took in milliseconds(ms)

input: unknown

operation_status: "SUCCESS" | "ERROR"

The outcome of the operation

output: unknown

start_timestamp: string

chat_thread_id: string

Optional

interaction_source: "EXTERNAL_AI" | "EVALUATION" | "SGP_CHAT" | 1 more...

Optional

operation_metadata: unknown

Optional

The JSON representation of the metadata insights emitted through the execution. This can differ based on different types of operations

Request example

curl https://api.egp.scale.com/v4/threads/$THREAD_ID/messages/$APPLICATION_INTERACTION_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{}'

200Example

{
  "id": "id",
  "aggregated": true,
  "application_spec_id": "application_spec_id",
  "application_variant_id": "application_variant_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "duration_ms": 0,
  "input": {},
  "operation_status": "SUCCESS",
  "output": {},
  "start_timestamp": "2019-12-27T18:11:19.117Z",
  "chat_thread_id": "chat_thread_id",
  "interaction_source": "EXTERNAL_AI",
  "operation_metadata": {}
}

Chat Threads Messages

Feedback

chat_threads.messages.feedback

Methods

Delete Interaction Feedback -> unknown

delete/v4/threads/{thread_id}/messages/{application_interaction_id}/feedback

Delete Interaction Feedback