🚀 Alchemyst is now the Pareto Frontier for AI Context! Learn more
API documentation
Endpoint examples
- POSTAdd context data to the context processor
- POSTAdd context data to the context processor
- GETList all ongoing context add jobs for the authenticated user
- DELCancel a context add job
- GETGet status of a context add job
- POSTDelete context data
- POSTAdd memory context data
- POSTDelete memory context data
- POSTUpdate memory context data
- POSTSearch for context data in the context processor
- GETRetrieves a list of traces for the authenticated user
- DELDelete a specific data trace
- GETRetrieve user contexts by documents.
- GETRetrieve user context
- POSTView organization context
curl --request POST \
--url https://platform-backend.getalchemystai.com/api/v1/context/add \
--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
}
}
'{}Add context data to the context processor
This endpoint accepts context data and sends it to a context processor for further handling. It returns a success or error response depending on the result from the context processor.
curl --request POST \
--url https://platform-backend.getalchemystai.com/api/v1/context/add \
--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
}
}
'{}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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Array of documents with content and additional metadata
Show child attributes
Show child attributes
The source of the context data
Type of context being added
resource, conversation, instruction Scope of the context
internal, external Additional metadata for the context
Show child attributes
Show child attributes
Response
Context added successfully
The response is of type object.