Outputs

Get task output

Rows from the active output. Partial rows are readable during a run. Page with limit and cursor: JSON carries _next_cursor; CSV and Markdown use X-Next-Cursor. Set format=csv for the current page as CSV, or format=md for person profiles as Markdown.

get/task/{task_id}/output

Request

  • Base URL
    https://api.autumn.ai
  • URL
    https://api.autumn.ai/task/{task_id}/output
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

task_idstring required

The task_id returned by POST /task or POST /task/start.

Example:8fab6f34

Query parameters

limitinteger

Maximum number of rows to return.

outputstring

Read this output id instead of the active one.

cursorstring

Resume from the _next_cursor of the previous page.

format'json' | 'csv' | 'md'

Return the current page as JSON, CSV, or Markdown. md renders person outputs as the profile document the platform exports.

Response

Output page as JSON, CSV, or Markdown.

totalinteger required

Rows available before limit.

offsetinteger
rowsobject[] required
outputobject nullable

The artifact these rows belong to: id, kind, path.

_next_cursorstring nullable

Present when more rows remain. Pass it as cursor to read the next page.

Example response

{
  "total": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.