BEbeyondwords
Agent

Show

Changed on

Get the Agent state for your project

get/projects/{project_id}/agent

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/agent
  • Auth
    API key in header X-Api-Key

Response

enabled with progress counts

enabledboolean

Whether the Agent is enabled for this project.

status'disabled' | 'indexing' | 'enabled' | 'error'

Overall lifecycle status of the Agent.

content_total_countinteger

Current known eligible article count for the project.

content_embedded_countinteger

Number of articles embedded into the vector index.

content_pending_countinteger

Number of articles queued or not yet embedded.

content_failed_countinteger

Number of articles that failed to embed.

indexed_datestring date-time nullable
enabled_datestring date-time nullable
errorstring nullable

Changes