POST /api/chat

Public access · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Attachments contain extracted text, not raw uploads. At most four attachments and 24,000 total content characters are accepted.
Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.

Request

Parameter	Location	Type and requirement
`x-idempotency-key`	header	string · optional Pattern: `^[A-Za-z0-9_-]{8,128}$`
`Origin`	header	string · required An origin allowed by this deployment.
`X-CSRF-Token`	header	string · required Must match the CSRF cookie issued to this browser.

Body · application/json

message required · string

conversationId optional · string

attachments optional · array of object

maxItems: 4

View attachments model

Array items:

fileName required · string

minLength: 1. maxLength: 120

mimeType required · string

minLength: 1. maxLength: 120

sizeBytes required · number

minimum: 0. maximum: 2000000

content required · string

minLength: 1. maxLength: 12000

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.

Save as request.json

{
  "message": "Explain the data used in this research."
}

cURL (POSIX shell)

curl --include \
  --request POST \
  'https://api.weavers.app/api/chat' \
  --cookie cookies.txt --cookie-jar cookies.txt \
  --header 'Origin: https://weavers.app' \
  --header "X-CSRF-Token: ${CSRF_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "reply": "example",
  "conversationId": "1",
  "provider": "github"
}

View response model

reply required · string

conversationId required · string

provider required · string

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{
  "error": "example"
}

View response model

Variant 1: object

error required · string

Additional fields: JSON values.

Variant 2: object

error required · string

code required · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data

{
  "error": "example"
}

View response model

Variant 1: object

error required · string

Additional fields: JSON values.

409 · Revision, state or idempotency conflict.

application/json

409 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.

502 · Dependency failure.

application/json

502 example · synthetic data

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

View response model

error required · string

code required · string

Additional fields: JSON values.

503 · Service or dependency unavailable.

application/json

503 example · synthetic data

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

View response model

error required · string

code required · 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": "example"
}

View response model

error required · string

code required · string

Additional fields: JSON values.