Ask agent

POST

https://api.sureshake.com/v2/reports/{id}/agent/messages

Path parameters

id
string
required
format: uuid

Request body JSON required

message
string
required
maxLength: 4000 · minLength: 1
history
optional
array of
object
- role
  user
  or
  assistant
  required
- content
  string
  required
}

Returns

200

Default Response

JSON

data
object
required
- message
  string
  required
- citations
  array of
  object
  required
  id
  string
  required
  label
  string
  required
  section_key
  string
  required
  source_type
  string
  required
  provenance
  optional
  string
  or null
  metadata
  optional
  map of
  unknown
- unavailable
  array of
  string
  required
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request POST \ --url 'https://api.sureshake.com/v2/reports/<id>/agent/messages' \ --header 'Content-Type: application/json' \ --data ' { "message": "string", "history": [ { "role": "user", "content": "string" } ] } '

{ "data": { "message": "string", "citations": [ { "id": "string", "label": "string", "section_key": "string", "source_type": "string", "provenance": "string", "metadata": { "property1": null, "property2": null } } ], "unavailable": [ "string" ] } }