Woz

/woz/documents/content

Add text content to be indexed

post/woz/documents/content

Request

  • Base URL
    <<api-url>> (relative, and the document’s source URL is not known)
  • Auth
    API key in header X-API-KEY

Headers

octa-agent-emailstring

Request body

contentstring required

Text content to be indexed

titlestring

Descriptive title. Used as the .txt file name and as idempotency key. If omitted, uses the document ID.

agentIdsstring[]

IDs of agents that will have access to the content. If omitted, linked to the default agent.

Example request

{
  "content": "Nossa política de devolução permite troca em até 30 dias.",
  "title": "Título do conteúdo",
  "agentIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

Response

idstring required

Document ID

externalKeystring required

External key for idempotency

statusstring required

Processing status

activeboolean required

Whether the document is active

createdAtstring required

Creation timestamp

Changes

No recorded changes to this operation across all 2 revisions of this API.