OCTOPUS docsocto.ad

Docs / Reference / REST: POST /api/ask

REST: POST /api/ask

Request and response fields for the public question endpoint.

Request

POST https://octo.ad/api/ask, body JSON:

FieldTypeRequiredMeaning
messagestringyesYour question, up to 2,000 characters.
session_idstringnoContinue an earlier conversation.

Response

FieldMeaning
answerThe answer, from public material.
follow_upA suggested next question or step.
session_idSend it back to continue.
statusA state for the conversation. Treat it as opaque; its values are not published.

A response looks like this (values shortened):

{"answer": "OCTOPUS by ARAMAI is the harness for enterprise AI ...", "follow_up": "...", "session_id": "...", "status": "..."}

Errors

CodeWhen
400The body is not valid.
429The daily limit was reached.
503The answer could not be produced right now.