Skip to main content
POST
/
api
/
v1
/
context
/
add-async
Asynchronously queue context data to add to the context processor
curl --request POST \
  --url https://platform-backend.getalchemystai.com/api/v1/context/add-async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documents": [
    {
      "content": "Customer asked about pricing for the Scale plan."
    }
  ],
  "source": "support-inbox",
  "context_type": "resource",
  "scope": "internal",
  "metadata": {
    "fileName": "support_thread_TCK-1234.txt",
    "fileType": "text/plain",
    "groupName": [
      "support",
      "pricing"
    ],
    "lastModified": "2025-01-10T12:34:56.000Z",
    "fileSize": 2048
  }
}
'
{
  "queued": true,
  "jobId": "context-add-123456"
}

Documentation Index

Fetch the complete documentation index at: https://getalchemystai.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
documents
object[]
required

Array of documents with content and additional metadata

​
source
string
required

The source of the context data

​
context_type
enum<string>
required

Type of context being added

Available options:
resource,
conversation,
instruction
​
scope
enum<string>
default:internal
required

Scope of the context

Available options:
internal,
external
​
metadata
object

Additional metadata for the context

Response

Context queued successfully

​
queued
boolean
required
Example:

true

​
jobId
string
required
Example:

"context-add-123456"