ContextualAI · lingxi-at-contextual · Aug 26, 2025 · May 22, 2025 · May 28, 2025 · Jun 4, 2025
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,12 +7,17 @@ on:
       - 'integrated/**'
       - 'stl-preview-head/**'
       - 'stl-preview-base/**'
+  pull_request:
+    branches-ignore:
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:
     timeout-minutes: 10
     name: lint
     runs-on: ${{ github.repository == 'stainless-sdks/sunrise-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@v4
 
@@ -31,6 +36,7 @@ jobs:
     timeout-minutes: 5
     name: build
     runs-on: ${{ github.repository == 'stainless-sdks/sunrise-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     permissions:
       contents: read
       id-token: write
@@ -66,6 +72,7 @@ jobs:
     timeout-minutes: 10
     name: test
     runs-on: ${{ github.repository == 'stainless-sdks/sunrise-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.fork
     steps:
       - uses: actions/checkout@v4
 

diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.7.0"
+  ".": "0.8.0"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
-configured_endpoints: 52
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-8d75c58c83d13f67b6a125c3eb4639d213c91aec7dbb6e06f0cd5bdfc074d54e.yml
-openapi_spec_hash: 47795284631814d0f8eb42f6a0d5a3b3
-config_hash: 1ecef0ff4fd125bbc00eec65e3dd4798
+configured_endpoints: 34
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-db7245c74772a8cd47c02886619fed0568fbb58b1fa8aba0dc77524b924a4fb6.yml
+openapi_spec_hash: ca3de8d7b14b78683e39464fe7d4b1e1
+config_hash: 410f8a2f86f605885911277be47c3c78
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,47 @@
 # Changelog
 
+## 0.8.0 (2025-08-26)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/ContextualAI/contextual-client-node/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** update via SDK Studio ([1cd61de](https://github.com/ContextualAI/contextual-client-node/commit/1cd61de5fa3d11098d3ca5f4afef6caa67cac129))
+* **api:** update via SDK Studio ([461f964](https://github.com/ContextualAI/contextual-client-node/commit/461f964fd0e3209c1dd3094e347455d492afbe7c))
+* **client:** add support for endpoint-specific base URLs ([4375198](https://github.com/ContextualAI/contextual-client-node/commit/4375198ddd324eadac0053fbf0e9284f0686f6a5))
+
+
+### Bug Fixes
+
+* **ci:** release-doctor — report correct token name ([2339044](https://github.com/ContextualAI/contextual-client-node/commit/2339044a28b8491311eb984fbe0f5b2497e57b32))
+* **client:** don't send `Content-Type` for bodyless methods ([70fe78d](https://github.com/ContextualAI/contextual-client-node/commit/70fe78dada5b43beb40a5efb9d371cdcb2ac8ea0))
+* publish script — handle NPM errors correctly ([9855ea4](https://github.com/ContextualAI/contextual-client-node/commit/9855ea41c55355a17d1a6282bc8d158b72da2f63))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([23d5fa7](https://github.com/ContextualAI/contextual-client-node/commit/23d5fa79636f991e3d4ff7a454ee973bb1fc2691))
+* **ci:** only run for pushes and fork pull requests ([da8f41a](https://github.com/ContextualAI/contextual-client-node/commit/da8f41a626313a61f8eec1ccb52834021ec5c134))
+* **deps:** update dependency node-fetch to v2.6.13 ([a78c708](https://github.com/ContextualAI/contextual-client-node/commit/a78c708d54ad4a15626784c2cd28f9f5badd32bf))
+* **docs:** grammar improvements ([92210b2](https://github.com/ContextualAI/contextual-client-node/commit/92210b2f9cbfd930dfb7fcc8c6464a8d0c89bda7))
+* **docs:** use top-level-await in example snippets ([39783f4](https://github.com/ContextualAI/contextual-client-node/commit/39783f455c8d9d669d42a0671b239b51a196f743))
+* improve publish-npm script --latest tag logic ([bf8c320](https://github.com/ContextualAI/contextual-client-node/commit/bf8c320845e3781558b5c89c2d0dfda127138d13))
+* **internal:** formatting change ([377f894](https://github.com/ContextualAI/contextual-client-node/commit/377f8945d985646d593b5b7ab5d4b4f8b49e3f8c))
+* **internal:** make base APIResource abstract ([122895d](https://github.com/ContextualAI/contextual-client-node/commit/122895d96bcc6de97dc918dca7b62d8ababb0af5))
+* **internal:** move publish config ([119c90e](https://github.com/ContextualAI/contextual-client-node/commit/119c90eb630dd8f659ceaa54b0b8e2b9b066c5f4))
+* **internal:** remove redundant imports config ([81939bc](https://github.com/ContextualAI/contextual-client-node/commit/81939bc05046667a6abe50b9a004b876b69a2cbc))
+* **internal:** update comment in script ([4c94556](https://github.com/ContextualAI/contextual-client-node/commit/4c94556258643943f9b0bb20ec704031cd5aaea2))
+* **internal:** update examples ([8b244f3](https://github.com/ContextualAI/contextual-client-node/commit/8b244f3de7b94001daf4e2de4761d57454d34fb9))
+* make some internal functions async ([cfbf5bc](https://github.com/ContextualAI/contextual-client-node/commit/cfbf5bc81cb65347306a63f6901c0682f2a827cf))
+* mention unit type in timeout docs ([4271686](https://github.com/ContextualAI/contextual-client-node/commit/427168601652284f4f664680cd66302d4ac5485a))
+* update @stainless-api/prism-cli to v5.15.0 ([5357389](https://github.com/ContextualAI/contextual-client-node/commit/5357389ae828af04cb9595175c2603554d43902a))
+* update CI script ([b12ee6f](https://github.com/ContextualAI/contextual-client-node/commit/b12ee6ff77acc76f4e15a75e6b980fb01a09b1e0))
+
+
+### Refactors
+
+* **types:** replace Record with mapped types ([b50e9f1](https://github.com/ContextualAI/contextual-client-node/commit/b50e9f1b6306889aff9ee34fb2d29dcad6d8c3f7))
+
 ## 0.7.0 (2025-05-13)
 
 Full Changelog: [v0.6.0...v0.7.0](https://github.com/ContextualAI/contextual-client-node/compare/v0.6.0...v0.7.0)

diff --git a/README.md b/README.md
@@ -24,13 +24,9 @@ const client = new ContextualAI({
   apiKey: process.env['CONTEXTUAL_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const createAgentOutput = await client.agents.create({ name: 'Example' });
+const createAgentOutput = await client.agents.create({ name: 'Example' });
 
-  console.log(createAgentOutput.id);
-}
-
-main();
+console.log(createAgentOutput.id);
 ```
 
 ### Request & Response types
@@ -45,12 +41,8 @@ const client = new ContextualAI({
   apiKey: process.env['CONTEXTUAL_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const params: ContextualAI.AgentCreateParams = { name: 'Example' };
-  const createAgentOutput: ContextualAI.CreateAgentOutput = await client.agents.create(params);
-}
-
-main();
+const params: ContextualAI.AgentCreateParams = { name: 'Example' };
+const createAgentOutput: ContextualAI.CreateAgentOutput = await client.agents.create(params);
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -103,19 +95,15 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-async function main() {
-  const createAgentOutput = await client.agents.create({ name: 'Example' }).catch(async (err) => {
-    if (err instanceof ContextualAI.APIError) {
-      console.log(err.status); // 400
-      console.log(err.name); // BadRequestError
-      console.log(err.headers); // {server: 'nginx', ...}
-    } else {
-      throw err;
-    }
-  });
-}
-
-main();
+const createAgentOutput = await client.agents.create({ name: 'Example' }).catch(async (err) => {
+  if (err instanceof ContextualAI.APIError) {
+    console.log(err.status); // 400
+    console.log(err.name); // BadRequestError
+    console.log(err.headers); // {server: 'nginx', ...}
+  } else {
+    throw err;
+  }
+});
 ```
 
 Error codes are as follows:

diff --git a/SECURITY.md b/SECURITY.md
@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Contextual AI please follow the respective company's security reporting guidelines.
+or products provided by Contextual AI, please follow the respective company's security reporting guidelines.
 
 ### Contextual AI Terms and Policies
 
-Please contact support@contextual.ai for any questions or concerns regarding security of our services.
+Please contact support@contextual.ai for any questions or concerns regarding the security of our services.
 
 ---
 

diff --git a/api.md b/api.md
@@ -6,12 +6,14 @@ Types:
 - <code><a href="./src/resources/datastores/datastores.ts">Datastore</a></code>
 - <code><a href="./src/resources/datastores/datastores.ts">DatastoreMetadata</a></code>
 - <code><a href="./src/resources/datastores/datastores.ts">ListDatastoresResponse</a></code>
+- <code><a href="./src/resources/datastores/datastores.ts">DatastoreUpdateResponse</a></code>
 - <code><a href="./src/resources/datastores/datastores.ts">DatastoreDeleteResponse</a></code>
 - <code><a href="./src/resources/datastores/datastores.ts">DatastoreResetResponse</a></code>
 
 Methods:
 
 - <code title="post /datastores">client.datastores.<a href="./src/resources/datastores/datastores.ts">create</a>({ ...params }) -> CreateDatastoreResponse</code>
+- <code title="put /datastores/{datastore_id}">client.datastores.<a href="./src/resources/datastores/datastores.ts">update</a>(datastoreId, { ...params }) -> DatastoreUpdateResponse</code>
 - <code title="get /datastores">client.datastores.<a href="./src/resources/datastores/datastores.ts">list</a>({ ...params }) -> DatastoresDatastoresPage</code>
 - <code title="delete /datastores/{datastore_id}">client.datastores.<a href="./src/resources/datastores/datastores.ts">delete</a>(datastoreId) -> unknown</code>
 - <code title="get /datastores/{datastore_id}/metadata">client.datastores.<a href="./src/resources/datastores/datastores.ts">metadata</a>(datastoreId) -> DatastoreMetadata</code>
@@ -21,16 +23,19 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/datastores/documents.ts">BaseMetadataFilter</a></code>
 - <code><a href="./src/resources/datastores/documents.ts">CompositeMetadataFilter</a></code>
 - <code><a href="./src/resources/datastores/documents.ts">DocumentMetadata</a></code>
 - <code><a href="./src/resources/datastores/documents.ts">IngestionResponse</a></code>
 - <code><a href="./src/resources/datastores/documents.ts">ListDocumentsResponse</a></code>
 - <code><a href="./src/resources/datastores/documents.ts">DocumentDeleteResponse</a></code>
+- <code><a href="./src/resources/datastores/documents.ts">DocumentGetParseResultResponse</a></code>
 
 Methods:
 
 - <code title="get /datastores/{datastore_id}/documents">client.datastores.documents.<a href="./src/resources/datastores/documents.ts">list</a>(datastoreId, { ...params }) -> DocumentMetadataDocumentsPage</code>
 - <code title="delete /datastores/{datastore_id}/documents/{document_id}">client.datastores.documents.<a href="./src/resources/datastores/documents.ts">delete</a>(datastoreId, documentId) -> unknown</code>
+- <code title="get /datastores/{datastore_id}/documents/{document_id}/parse">client.datastores.documents.<a href="./src/resources/datastores/documents.ts">getParseResult</a>(datastoreId, documentId, { ...params }) -> DocumentGetParseResultResponse</code>
 - <code title="post /datastores/{datastore_id}/documents">client.datastores.documents.<a href="./src/resources/datastores/documents.ts">ingest</a>(datastoreId, { ...params }) -> IngestionResponse</code>
 - <code title="get /datastores/{datastore_id}/documents/{document_id}/metadata">client.datastores.documents.<a href="./src/resources/datastores/documents.ts">metadata</a>(datastoreId, documentId) -> DocumentMetadata</code>
 - <code title="post /datastores/{datastore_id}/documents/{document_id}/metadata">client.datastores.documents.<a href="./src/resources/datastores/documents.ts">setMetadata</a>(datastoreId, documentId, { ...params }) -> DocumentMetadata</code>
@@ -59,6 +64,7 @@ Methods:
 - <code title="put /agents/{agent_id}">client.agents.<a href="./src/resources/agents/agents.ts">update</a>(agentId, { ...params }) -> unknown</code>
 - <code title="get /agents">client.agents.<a href="./src/resources/agents/agents.ts">list</a>({ ...params }) -> AgentsPage</code>
 - <code title="delete /agents/{agent_id}">client.agents.<a href="./src/resources/agents/agents.ts">delete</a>(agentId) -> unknown</code>
+- <code title="post /agents/{agent_id}/copy">client.agents.<a href="./src/resources/agents/agents.ts">copy</a>(agentId) -> CreateAgentOutput</code>
 - <code title="get /agents/{agent_id}/metadata">client.agents.<a href="./src/resources/agents/agents.ts">metadata</a>(agentId) -> AgentMetadataResponse</code>
 - <code title="put /agents/{agent_id}/reset">client.agents.<a href="./src/resources/agents/agents.ts">reset</a>(agentId) -> unknown</code>
 
@@ -78,102 +84,6 @@ Methods:
 - <code title="get /agents/{agent_id}/metrics">client.agents.query.<a href="./src/resources/agents/query.ts">metrics</a>(agentId, { ...params }) -> QueryMetricsResponse</code>
 - <code title="get /agents/{agent_id}/query/{message_id}/retrieval/info">client.agents.query.<a href="./src/resources/agents/query.ts">retrievalInfo</a>(agentId, messageId, { ...params }) -> RetrievalInfoResponse</code>
 
-## Evaluate
-
-Types:
-
-- <code><a href="./src/resources/agents/evaluate/evaluate.ts">CreateEvaluationResponse</a></code>
-
-Methods:
-
-- <code title="post /agents/{agent_id}/evaluate">client.agents.evaluate.<a href="./src/resources/agents/evaluate/evaluate.ts">create</a>(agentId, { ...params }) -> CreateEvaluationResponse</code>
-
-### Jobs
-
-Types:
-
-- <code><a href="./src/resources/agents/evaluate/jobs.ts">EvaluationJobMetadata</a></code>
-- <code><a href="./src/resources/agents/evaluate/jobs.ts">ListEvaluationJobsResponse</a></code>
-- <code><a href="./src/resources/agents/evaluate/jobs.ts">JobCancelResponse</a></code>
-
-Methods:
-
-- <code title="get /agents/{agent_id}/evaluate/jobs">client.agents.evaluate.jobs.<a href="./src/resources/agents/evaluate/jobs.ts">list</a>(agentId) -> ListEvaluationJobsResponse</code>
-- <code title="post /agents/{agent_id}/evaluate/jobs/{job_id}/cancel">client.agents.evaluate.jobs.<a href="./src/resources/agents/evaluate/jobs.ts">cancel</a>(agentId, jobId) -> unknown</code>
-- <code title="get /agents/{agent_id}/evaluate/jobs/{job_id}/metadata">client.agents.evaluate.jobs.<a href="./src/resources/agents/evaluate/jobs.ts">metadata</a>(agentId, jobId) -> EvaluationJobMetadata</code>
-
-## Datasets
-
-Types:
-
-- <code><a href="./src/resources/agents/datasets/datasets.ts">CreateDatasetResponse</a></code>
-- <code><a href="./src/resources/agents/datasets/datasets.ts">DatasetMetadata</a></code>
-- <code><a href="./src/resources/agents/datasets/datasets.ts">ListDatasetsResponse</a></code>
-
-### Tune
-
-Types:
-
-- <code><a href="./src/resources/agents/datasets/tune.ts">TuneDeleteResponse</a></code>
-
-Methods:
-
-- <code title="post /agents/{agent_id}/datasets/tune">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">create</a>(agentId, { ...params }) -> CreateDatasetResponse</code>
-- <code title="get /agents/{agent_id}/datasets/tune/{dataset_name}">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">retrieve</a>(agentId, datasetName, { ...params }) -> Response</code>
-- <code title="put /agents/{agent_id}/datasets/tune/{dataset_name}">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">update</a>(agentId, datasetName, { ...params }) -> CreateDatasetResponse</code>
-- <code title="get /agents/{agent_id}/datasets/tune">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">list</a>(agentId, { ...params }) -> ListDatasetsResponse</code>
-- <code title="delete /agents/{agent_id}/datasets/tune/{dataset_name}">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">delete</a>(agentId, datasetName) -> unknown</code>
-- <code title="get /agents/{agent_id}/datasets/tune/{dataset_name}/metadata">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">metadata</a>(agentId, datasetName, { ...params }) -> DatasetMetadata</code>
-
-### Evaluate
-
-Types:
-
-- <code><a href="./src/resources/agents/datasets/evaluate.ts">EvaluateDeleteResponse</a></code>
-
-Methods:
-
-- <code title="post /agents/{agent_id}/datasets/evaluate">client.agents.datasets.evaluate.<a href="./src/resources/agents/datasets/evaluate.ts">create</a>(agentId, { ...params }) -> CreateDatasetResponse</code>
-- <code title="get /agents/{agent_id}/datasets/evaluate/{dataset_name}">client.agents.datasets.evaluate.<a href="./src/resources/agents/datasets/evaluate.ts">retrieve</a>(agentId, datasetName, { ...params }) -> Response</code>
-- <code title="put /agents/{agent_id}/datasets/evaluate/{dataset_name}">client.agents.datasets.evaluate.<a href="./src/resources/agents/datasets/evaluate.ts">update</a>(agentId, datasetName, { ...params }) -> CreateDatasetResponse</code>
-- <code title="get /agents/{agent_id}/datasets/evaluate">client.agents.datasets.evaluate.<a href="./src/resources/agents/datasets/evaluate.ts">list</a>(agentId, { ...params }) -> ListDatasetsResponse</code>
-- <code title="delete /agents/{agent_id}/datasets/evaluate/{dataset_name}">client.agents.datasets.evaluate.<a href="./src/resources/agents/datasets/evaluate.ts">delete</a>(agentId, datasetName) -> unknown</code>
-- <code title="get /agents/{agent_id}/datasets/evaluate/{dataset_name}/metadata">client.agents.datasets.evaluate.<a href="./src/resources/agents/datasets/evaluate.ts">metadata</a>(agentId, datasetName, { ...params }) -> DatasetMetadata</code>
-
-## Tune
-
-Types:
-
-- <code><a href="./src/resources/agents/tune/tune.ts">CreateTuneResponse</a></code>
-
-Methods:
-
-- <code title="post /agents/{agent_id}/tune">client.agents.tune.<a href="./src/resources/agents/tune/tune.ts">create</a>(agentId, { ...params }) -> CreateTuneResponse</code>
-
-### Jobs
-
-Types:
-
-- <code><a href="./src/resources/agents/tune/jobs.ts">ListTuneJobsResponse</a></code>
-- <code><a href="./src/resources/agents/tune/jobs.ts">TuneJobMetadata</a></code>
-- <code><a href="./src/resources/agents/tune/jobs.ts">JobDeleteResponse</a></code>
-
-Methods:
-
-- <code title="get /agents/{agent_id}/tune/jobs">client.agents.tune.jobs.<a href="./src/resources/agents/tune/jobs.ts">list</a>(agentId) -> ListTuneJobsResponse</code>
-- <code title="delete /agents/{agent_id}/tune/jobs/{job_id}">client.agents.tune.jobs.<a href="./src/resources/agents/tune/jobs.ts">delete</a>(agentId, jobId) -> unknown</code>
-- <code title="get /agents/{agent_id}/tune/jobs/{job_id}/metadata">client.agents.tune.jobs.<a href="./src/resources/agents/tune/jobs.ts">metadata</a>(agentId, jobId) -> TuneJobMetadata</code>
-
-### Models
-
-Types:
-
-- <code><a href="./src/resources/agents/tune/models.ts">ListTuneModelsResponse</a></code>
-
-Methods:
-
-- <code title="get /agents/{agent_id}/tune/models">client.agents.tune.models.<a href="./src/resources/agents/tune/models.ts">list</a>(agentId) -> ListTuneModelsResponse</code>
-
 # Users
 
 Types:

diff --git a/bin/check-release-environment b/bin/check-release-environment
@@ -3,7 +3,7 @@
 errors=()
 
 if [ -z "${NPM_TOKEN}" ]; then
-  errors+=("The CONTEXTUAL_AI_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+  errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
 fi
 
 lenErrors=${#errors[@]}