Skip to main content
POST
Import file through agent workflow

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

project_id
string
required
file_id
string
required

Body

application/json
instructions
string | null

Optional guidance for the import (e.g. how to interpret columns).

chat_id
string | null

Existing conversation to run the import in; a new one starts when omitted.

title
string | null

Optional title for the import conversation.

Response

Server-Sent Events stream of agent activity.

Each event is a UTF-8 line prefixed with event:, id:, or data: per the SSE spec. The data: payload is a JSON object with the shape {"type": <event_type>, "sequence": <int>, "data": <object>}.

Event types emitted by the agent:

  • status — high-level progress; data.message (queued/running text) or data.summary (short status line)
  • tool.started — agent invoked a tool; data.id, data.name
  • tool.input — tool input arguments; data.id, data.name, data.input
  • tool.completed — tool finished; data.id
  • message.delta — incremental assistant text; data.text (append in order)
  • done — terminal event; data.messageId, data.content (final assistant message), data.status (complete / error / cancelled)

Resumability: when the connection drops before done, the same stream can be resumed via GET /v1/projects/{project_id}/conversations/{chat_id}/messages/{message_id}/events.