business_knowledge

Get a business knowledge sandbox run

Poll a sandbox run started by the current user. A run that started before AI data processing was turned off can still be read.

get/api/projects/{project_id}/business_knowledge/sandbox/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/business_knowledge/sandbox/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required
project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Current sandbox run.

task_idstring uuid required

Sandbox task id.

run_idstring uuid required

Latest run id for this task.

status'running' | 'completed' | 'failed' | 'cancelled' required
  • running - Running
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
replystring nullable required

Answer text when status is completed. Null otherwise.

errorstring nullable required

Why the run did not produce an answer. Null while running and on a completed answer.

docs_search_calledboolean required

True when the run log contains an exact docs-search call. That tool is not granted to this sandbox.

Changes

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