Post Chat

POST

/api/v1/projects/{project_id}/chat

const url = 'https://aura.strangeworks.com/api/v1/projects/example/chat';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"client_msg_id":"example","content":"example","context":[],"conversation_id":"example","file_ids":[]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://aura.strangeworks.com/api/v1/projects/example/chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "client_msg_id": "example", "content": "example", "context": [], "conversation_id": "example", "file_ids": [] }'

Authorizations

apiKey

Parameters

Path Parameters

project_id

required

Project Id

string

Request Body^required

application/json

ChatMessageCreate

object

client_msg_id

Any of:

string
null

string

content

required

Content

string

context

Context

Array<object>

default:

ContextRef

object

required

string

type

required

Type

string

Allowed values: card file decision panel view

conversation_id

Any of:

string
null

string

file_ids

File Ids

Array<string>

default:

Responses

202

Successful Response

application/json

ChatResponse

Response from the chat endpoint (202 accepted).

object

canvas_snapshot

Canvas Snapshot

Array<object>

default:

CardResponse

object

card_type

required

CardType

string

Allowed values: resource demand constraint kpi production

constraint_nature

Any of:

string
null

string

created_at

required

Created At

string format: date-time

data

required

Data

object

key

additional properties

gaps

required

Gaps

Array<object>

GapInfo

object

field

required

Field

string

message

required

Message

string

severity

required

Severity

string

Allowed values: red yellow

required

string

instance_data

Instance Data

object

key

additional properties

label

required

Label

string

project_id

required

Project Id

string

source_message_id

required

Any of:

string
null

string

status

required

CardStatus

string

Allowed values: red yellow green

updated_at

required

Updated At

string format: date-time

version

required

Version

integer

violation_penalty

Any of:

string
null

string

message

required

ChatMessageResponse

object

affected_card_ids

required

Affected Card Ids

Array<string>

client_msg_id

Any of:

string
null

string

content

required

Content

string

content_segments

Any of:

Array<object>
null

Array<object>

ContentSegmentData

A single segment in the interleaved content stream.

object

card_id

Any of:

string
null

string

children

Any of:

Array<object>
null

Array<object>

ToolCallData

A single tool call recorded on a chat message.

object

card_id

Any of:

string
null

string

children

Any of:

Array<object>
null

Array<object> recursive

completed_at

Any of:

string
null

string format: date-time

duration_ms

Any of:

integer
null

integer

error

Any of:

string
null

string

error_code

Any of:

string
null

string

error_details

Any of:

object
null

object

key

additional properties

execution_source

Any of:

string
null

string

file_path

Any of:

string
null

string

required

string

input

Any of:

object
null

object

key

additional properties

owner_id

Any of:

string
null

string

owner_type

Any of:

string
null

string

panel_key

Any of:

string
null

string

parent_tool_use_id

Any of:

string
null

string

result

Any of:

unknown
null

scope

Any of:

string
null

string

started_at

Any of:

string
null

string format: date-time

status

required

Status

string

Allowed values: running completed failed unknown

stream_id

Any of:

string
null

string

summary

Any of:

string
null

string

tool

required

Tool

string

turn_id

Any of:

string
null

string

completed_at

Any of:

string
null

string format: date-time

content

Any of:

string
null

string

duration_ms

Any of:

integer
null

integer

error

Any of:

string
null

string

error_code

Any of:

string
null

string

error_details

Any of:

object
null

object

key

additional properties

execution_source

Any of:

string
null

string

failure_count

Any of:

integer
null

integer

file_path

Any of:

string
null

string

has_failures

Any of:

boolean
null

boolean

Any of:

string
null

string

input

Any of:

object
null

object

key

additional properties

label

Any of:

string
null

string

meeting_id

Any of:

string
null

string

owner_id

Any of:

string
null

string

owner_type

Any of:

string
null

string

panel_key

Any of:

string
null

string

parent_tool_use_id

Any of:

string
null

string

result

Any of:

unknown
null

scope

Any of:

string
null

string

source

Any of:

string
null

string

started_at

Any of:

string
null

string format: date-time

status

Any of:

string
null

string

stream_id

Any of:

string
null

string

summary

Any of:

string
null

string

tool

Any of:

string
null

string

tool_count

Any of:

integer
null

integer

turn_id

Any of:

string
null

string

type

required

Type

string

Allowed values: text tool_call tool_summary recording

conversation_id

Any of:

string
null

string

created_at

required

Created At

string format: date-time

file_ids

Any of:

Array<string>
null

Array<string>

required

string

is_partial

Is Partial

boolean

project_id

required

Project Id

string

role

required

Role

string

Allowed values: user assistant system

sequence

required

Sequence

integer

tool_calls

Any of:

Array<object>
null

Array<object>

ToolCallData

A single tool call recorded on a chat message.

object

card_id

Any of:

string
null

string

children

Any of:

Array<object>
null

Array<object> recursive

completed_at

Any of:

string
null

string format: date-time

duration_ms

Any of:

integer
null

integer

error

Any of:

string
null

string

error_code

Any of:

string
null

string

error_details

Any of:

object
null

object

key

additional properties

execution_source

Any of:

string
null

string

file_path

Any of:

string
null

string

required

string

input

Any of:

object
null

object

key

additional properties

owner_id

Any of:

string
null

string

owner_type

Any of:

string
null

string

panel_key

Any of:

string
null

string

parent_tool_use_id

Any of:

string
null

string

result

Any of:

unknown
null

scope

Any of:

string
null

string

started_at

Any of:

string
null

string format: date-time

status

required

Status

string

Allowed values: running completed failed unknown

stream_id

Any of:

string
null

string

summary

Any of:

string
null

string

tool

required

Tool

string

turn_id

Any of:

string
null

string

user_avatar_url

Any of:

string
null

string

user_id

Any of:

string
null

string

user_name

Any of:

string
null

string

turn_id

Any of:

string
null

string

Example

{
  "canvas_snapshot": [],
  "message": {
    "content_segments": [
      {
        "children": [
          {
            "status": "running"
          }
        ],
        "type": "text"
      }
    ],
    "is_partial": false,
    "role": "user",
    "tool_calls": [
      {
        "status": "running"
      }
    ]
  }
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

Post Chat

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

202

Example

422

Examplegenerated

Request Body^required

Example^generated