BEbeyondwords
Agent

Update

Changed on

Enable/disable the Agent or update its settings

put/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

Request body

enabledboolean

Response

settings can be pre-configured while disabled, without triggering a sync

enabledboolean

Whether the Agent is enabled for this project.

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

Overall lifecycle status of the Agent.

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

Changes