Skip to main content
PATCH
/
utils
/
context-packs
/
{name}
Update a context pack
curl --request PATCH \
  --url https://api.example.com/utils/context-packs/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "meta_data": {},
  "config": {}
}
'
{
  "id": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "version": 123,
  "summary_version": 123,
  "key_topics": [
    "<string>"
  ],
  "topic_distribution": {},
  "meta_data": {},
  "config": {},
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "summary_text": "<string>",
  "archived_at": "2023-11-07T05:31:56Z",
  "deprecated_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "reactivated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Project-ID
string | null

Path Parameters

​
name
string
required

Context pack name

Body

application/json

Request to update a context pack.

​
description
string | null

Updated description

Maximum string length: 2000
​
meta_data
Meta Data · object

Updated metadata (replaces existing)

​
config
Config · object

Updated configuration (replaces existing)

Response

Successful Response

Response model for a context pack.

​
id
string
required

Context pack ID

​
organization_id
string
required

Organization ID

​
project_id
string
required

Project ID

​
name
string
required

Pack name

​
pack_type
enum<string>
required

Pack type

Available options:
user,
team,
project,
domain,
session,
data_source
​
version
integer
required

Version number

​
status
enum<string>
required

Current status

Available options:
active,
archived,
deprecated,
deleted
​
summary_version
integer
required

Summary version

​
key_topics
string[]
required

Key topics

​
topic_distribution
Topic Distribution · object
required

Topic distribution

​
meta_data
Meta Data · object
required

User-defined metadata

​
config
Config · object
required

Configuration

​
created_by
string
required

User resource URI who created this

​
updated_by
string
required

User resource URI who last updated this

​
created_at
string<date-time>
required

Creation timestamp

​
updated_at
string<date-time>
required

Last update timestamp

​
description
string | null

Description

​
summary_text
string | null

Generated summary

​
archived_at
string<date-time> | null

Archive timestamp

​
deprecated_at
string<date-time> | null

Deprecation timestamp

​
deleted_at
string<date-time> | null

Deletion timestamp

​
reactivated_at
string<date-time> | null

Last reactivation timestamp