Support Assistant

Get a support answer

Changed on

Returns a run started by your team, with the answer once it is ready. Prefer the support.run.completed and support.run.failed webhooks; use this as the fallback, waiting pollAfterSeconds between polls. costUsd is the amount billed for the question, never above maxCostUsd, and 0 for a failed run (pricing on Ask a support question).

get/v1/support/runs/{runId}

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/support/runs/{runId}
  • Auth: HTTP bearer

Path parameters

runIdstring required

Response

The run

runIdstring required

Run id, a 24-character hex string.

threadIdstring required

Conversation thread id. Send it back as threadId to ask a follow-up in the same thread.

status'queued' | 'running' | 'completed' | 'needs_human' | 'failed' required

queued and running are in progress. needs_human means the assistant handed the question to a person instead of answering; when supportTicket is set, a Zernio teammate has been notified and will follow up by email.

stopReason'answered' | 'human_review' | 'cost_cap' | 'deadline' | 'max_iterations' | 'error' | 'expired' | 'null' nullable required

Why the run stopped. Null while it is in progress.

questionstring nullable required

The question as asked, with leading and trailing whitespace trimmed. Null only on runs created before this field was added.

answerstring nullable required

The assistant's answer. Null while the run is in progress or when it failed.

costUsdnumber required

The exact amount charged for the question, in USD, never above maxCostUsd. 0 for a failed run.

maxCostUsdnumber required

The cost cap this run was started with, in USD.

createdAtstring date-time required
startedAtstring date-time nullable required
finishedAtstring date-time nullable required
pollAfterSecondsinteger

Seconds to wait before polling again. Present only while the run is queued or running.

Changes

  • 27c96850cc66Revision changes
    • info

      api operation id getSupportRun removed and replaced with getSupportAnswer

    • info

      api tag Support Assistant added

    • info

      api tag Support Runs removed

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 61eb7bfa8d15Revision changes
    • info

      added the required property to the response with the status