v3

latestOpenAPI 3.0.02026-08-081996601.2 MB

Agent Aliases

List artifacts on alias-routed session

Lists artifacts stored in a session originally created via this alias. Artifacts are files uploaded by the user or generated within the session.

get/v2/agent_aliases/{alias_key}/sessions/{session_key}/artifacts

Path parameters

alias_keystring required

The unique key that identifies an alias. Alias keys are independent of agent keys. The same string can exist as both an alias key and an agent key in the same customer account. Calls to /v2/agent_aliases/{key}/... target the alias. Calls to /v2/agents/{key}/... target the agent.

Example:support

session_keystring required

A unique key that identifies an agent session.

Example:customer_support_chat

Query parameters

metadata_filterstring

Example:source = 'user_upload' AND page_count >= 10

A filter expression to narrow the list to artifacts whose metadata matches. Field names refer to keys on the artifact's metadata object. Syntax is similar to a SQL WHERE clause, the same as the metadata_filter used in query requests. See metadata filters documentation for more information.

Examples:

source = 'user_upload'
page_count >= 10 AND category = 'report'
label LIKE 'draft%'
category IN ('report', 'invoice')
category IS NULL
"extraction.engine" = 'ocr' (nested fields use a quoted dotted path)
1 IN page_numbers (value present in an array)

limitinteger

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

sort_by'created_at' | 'updated_at'

order_by'asc' | 'desc'

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of artifacts in the session.

Example response

{
  "artifacts": [
    {
      "artifact_id": "art_report_pdf_a3f2",
      "filename": "report.pdf",
      "mime_type": "application/pdf",
      "size_bytes": 2048576,
      "checksum_sha256": "a3f2b1c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2",
      "metadata": {
        "original_filename": "report.pdf",
        "source": "user_upload"
      },
      "description": "Q4 financial report",
      "ttl_days": 30,
      "created_at": "2024-01-15T10:35:00Z",
      "updated_at": "2024-01-15T10:35:00Z",
      "data": "JVBERi0xLjQKJeLjz9MKMy4uLg=="
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}