Public: Tasks

Get an agent task

Poll this every 30-60 seconds while a task runs; a typical task settles in about five minutes.

resultingRoute is the page a build_page task produced. It is always empty for a prompt task, even on success: a free-form turn has no single route, and its result is the chat thread at chatUrl.

error is present only when status is failed.

get/api/v1/public/brands/{brandSlug}/tasks/{taskId}/

Request

  • Base URL: https://api.iterant.ai
  • URL: https://api.iterant.ai/api/v1/public/brands/{brandSlug}/tasks/{taskId}/
  • Auth: HTTP bearer

Path parameters

brandSlugstring required
taskIdstring uuid required

Response

taskIdstring uuid required
command'prompt' | 'build_page' required
  • prompt - Prompt
  • build_page - Build page
status'running' | 'succeeded' | 'failed' required
  • running - Running
  • succeeded - Succeeded
  • failed - Failed
createdAtstring date-time required
finishedAtstring date-time nullable required

Null while the task is running.

resultingRoutestring required

The route the build produced. Always empty for a "prompt" task: a free-form turn has no single route, so its result is the chat thread.

chatUrlstring required
errorstring

Present only when status is failed.

Changes

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