Ask your workspace (single-turn Q&A)

POST

/v1/ask

curl --request POST \
  --url https://shareout.site/v1/ask \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "question": "example", "workspace": "example" }'

• Production

Read-only answer over pages the caller can access. Same access scope as search. Triggered from Home Cmd+K when the query ends with ?.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

question

required

string

workspace

Workspace id to scope (optional for personal context).

string

Example^generated

{
  "question": "example",
  "workspace": "example"
}

Responses

200

Answer with page citations

Media typeapplication/json

object

answer

string

citations

Array<object>

object

artifact_id

string

title

string

url

string

Example^generated

{
  "answer": "example",
  "citations": [
    {
      "artifact_id": "example",
      "title": "example",
      "url": "example"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}