Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

GET /api/knowledge-assistant/proposals/:conversationId/:messageId

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

  • Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.

Request

ParameterLocationType and requirement
conversationIdpathstring · required
messageIdpathstring · required
scopeKeyquerystring · required

No request body.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

cURL (POSIX shell)
curl --include \
  --request GET \
  'https://api.weavers.app/api/knowledge-assistant/proposals/1/1?scopeKey=example' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data
{
  "conversationId": "1",
  "messageId": "1",
  "title": "Example research",
  "content": "Explain the data used in this research.",
  "responseMode": "document_draft",
  "sources": []
}
View response model
conversationId required · string
messageId required · string
title required · string
content required · string
responseMode required · "document_draft"
sources required · array of object
View sources model

Array items:

citation required · number
title required · string
documentKey required · null | string
View documentKey model
Variant 1: null

null

Variant 2: string

string

revisionId required · null | string
View revisionId model
Variant 1: null

null

Variant 2: string

string

scopeKey required · string
sourceProvider required · string
evidenceKinds required · array of string
View evidenceKinds model

Array items:

string

authority required · string
sensitivity required · string
excerpt required · string
provenance required · object
View provenance model

Additional fields: JSON value.

Additional fields: JSON values.

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

default · Operation-specific error. Inspect error/code before deciding whether to retry.

application/json

default example · synthetic data
{
  "error": "example",
  "code": "conversation_busy",
  "retryable": false
}
View response model
error required · string
code required · "conversation_busy" | "knowledge_assistant_disabled" | "knowledge_assistant_forbidden" | "knowledge_release_unavailable" | "retrieval_plan_invalid" | "retrieval_no_sources" | "request_conflict" | "rag_timeout" | "nvidia_unavailable" | "rag_invalid_response" | "conversation_not_found" | "proposal_not_found" | "proposal_forbidden"
retryable required · boolean

Additional fields: JSON values.