GET /api/knowledge-assistant/requests/:requestKey

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

Parameter	Location	Type and requirement
`requestKey`	path	string · 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/requests/example' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "status": "processing",
  "requestKey": "example"
}

View response model

Variant 1: object

status required · "processing"

requestKey required · string

Additional fields: JSON values.

Variant 2: object

status required · "completed"

requestKey required · string

response required · object

View response model

model required · string

answer required · string

responseMode required · "answer" | "document_draft"

retrievalPlanHash required · string

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.

conversationId required · string

userMessage required · object

View userMessage model

id required · string

conversationId required · string

role required · "user" | "assistant" | "system" | "tool"

content required · string

toolName required · null | string

View toolName model

Variant 1: null

null

Variant 2: string

string

toolCallId required · null | string

View toolCallId model

Variant 1: null

null

Variant 2: string

string

metadata required · object

View metadata model

Additional fields: JSON value.

promptTokens required · number

completionTokens required · number

totalTokens required · number

latencyMs required · null | number

View latencyMs model

Variant 1: null

null

Variant 2: number

number

errorCode required · null | string

View errorCode model

Variant 1: null

null

Variant 2: string

string

createdAt required · string

Additional fields: JSON values.

assistantMessage required · object

View assistantMessage model

id required · string

conversationId required · string

role required · "user" | "assistant" | "system" | "tool"

content required · string

toolName required · null | string

View toolName model

Variant 1: null

null

Variant 2: string

string

toolCallId required · null | string

View toolCallId model

Variant 1: null

null

Variant 2: string

string

metadata required · object

View metadata model

Additional fields: JSON value.

promptTokens required · number

completionTokens required · number

totalTokens required · number

latencyMs required · null | number

View latencyMs model

Variant 1: null

null

Variant 2: number

number

errorCode required · null | string

View errorCode model

Variant 1: null

null

Variant 2: string

string

createdAt required · string

Additional fields: JSON values.

Variant 3: object

status required · "failed"

requestKey required · string

retryable required · boolean

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.

404 · Resource or enabled capability not found.

application/json

404 example · synthetic data

{
  "error": "example",
  "code": "example"
}

View response model

error required · string

code required · 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

retryable required · boolean

Additional fields: JSON values.