API Reference

Update Context

This endpoint allows you to update either the name of the context, its description, or both. If you need to update the text content or file for a context, that can be done by updating a context version.

Endpoint
PATCH https://api.zatomic.ai/v1/contexts/{contextId}

// Example
PATCH https://api.zatomic.ai/v1/contexts/ctx_2qRzu8geIvfudcJTwP0pur4TbMJ

Endpoint Request

Request Properties
name
string, optional
Name of the context.
description
string, optional
Description of the context.
project_id
string, optional
The ID of the project that contains the context. Set to empty string ("") to remove context from project.
Request Body
{
   "name": "Context name",
   "description": "Context description.",
   "project_id": "prj_32hbc9w4iVeyUZ1iRvjZYUrvS73"
}

Endpoint Response

A successful call returns a response that contains the updated context object.

HTTP Status Codes
200 OK The context was updated.
404 Not Found The context didn't exist.
500 Internal Server Error Something went wrong on Zatomic's end.