Style & link updates Assistants deployment (#1724)

katmayb · web-flow · commit d2373be69995 · 2025-12-03T12:42:59.000-05:00
diff --git a/src/langsmith/assistants.mdx b/src/langsmith/assistants.mdx
@@ -9,7 +9,7 @@ For example, imagine a general-purpose writing agent built on a common graph arc
 
 ![assistant versions](/langsmith/images/assistants.png)
 
-The Agent Server API provides several endpoints for creating and managing assistants and their versions. See the @[API reference][AssistantsAPI] for more details.
+The Agent Server API provides several endpoints for creating and managing assistants and their versions. See the [API reference](/langsmith/server-api-ref) for more details.
 
 <Info>
 Assistants are a [LangSmith Deployment](/langsmith/deployments) concept. They are not available in the open source LangGraph library.
@@ -108,7 +108,7 @@ Assistants build on the LangGraph open source concept of [configuration](/oss/la
 
 While configuration is available in the open source LangGraph library, assistants are only present in [LangSmith Deployment](/langsmith/deployments) because they are tightly coupled to your deployed graph. Upon deployment, [Agent Server](/langsmith/agent-server) will automatically create a default assistant for each graph using the graph's default configuration settings.
 
-In practice, an assistant is just an _instance_ of a graph with a specific configuration. Therefore, multiple assistants can reference the same graph but can contain different configurations (e.g. prompts, models, tools). The LangSmith Deployment API provides several endpoints for creating and managing assistants. See the [API reference](https://langchain-ai.github.io/langgraph/cloud/reference/api/api_ref/) and [this how-to](/langsmith/configuration-cloud) for more details on how to create assistants.
+In practice, an assistant is just an _instance_ of a graph with a specific configuration. Therefore, multiple assistants can reference the same graph but can contain different configurations (e.g. prompts, models, tools). The LangSmith Deployment API provides several endpoints for creating and managing assistants. See the [API reference](/langsmith/server-api-ref) and [this how-to](/langsmith/configuration-cloud) for more details on how to create assistants.
 
 ### Versioning
 
@@ -188,7 +188,7 @@ When executing a run:
 - Multiple runs can use the same assistant configuration.
 - The assistant's configuration affects how the underlying graph executes.
 
-The Agent Server API provides several endpoints for creating and managing runs. For more details, refer to the [API reference](https://langchain-ai.github.io/langgraph/cloud/reference/api/api_ref/).
+The Agent Server API provides several endpoints for creating and managing runs. For more details, refer to the [API reference](/langsmith/server-api-ref)).
 
 ## Video guide
 
diff --git a/src/langsmith/use-threads.mdx b/src/langsmith/use-threads.mdx
@@ -99,18 +99,18 @@ curl --request POST \
 ```
 </CodeGroup>
 
-For more information, refer to the @[Python][ThreadsClient.create] and @[JS][ThreadsClient.create] SDK docs, or the @[REST API][ThreadsAPI.create] reference.
+For more information, refer to the @[Python][ThreadsClient.create] and @[JS][ThreadsClient.create] SDK docs, or the [REST API](/langsmith/agent-server-api/threads/create-thread) reference.
 
 Output:
 
-```
+```json
 {
-"thread_id": "123e4567-e89b-12d3-a456-426614174000",
-"created_at": "2025-05-12T14:04:08.268Z",
-"updated_at": "2025-05-12T14:04:08.268Z",
-"metadata": {},
-"status": "idle",
-"values": {}
+  "thread_id": "123e4567-e89b-12d3-a456-426614174000",
+  "created_at": "2025-05-12T14:04:08.268Z",
+  "updated_at": "2025-05-12T14:04:08.268Z",
+  "metadata": {},
+  "status": "idle",
+  "values": {}
 }
 ```
 
@@ -137,7 +137,7 @@ curl --request POST --url <DEPLOYMENT_URL>/threads/thread["thread_id"]/copy \
 ```
 </CodeGroup>
 
-For more information, refer to the @[Python][ThreadsClient.copy] and @[JS][ThreadsClient.copy] SDK docs, or the @[REST API][ThreadsAPI.copy] reference.
+For more information, refer to the @[Python][ThreadsClient.copy] and @[JS][ThreadsClient.copy] SDK docs, or the [REST API](/langsmith/agent-server-api/threads/copy-thread) reference.
 
 ### Prepopulated State
 
@@ -270,39 +270,41 @@ curl --request POST \
 
 Output:
 
-```
-{
-"thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
-"created_at": "2025-05-12T15:37:08.935038+00:00",
-"updated_at": "2025-05-12T15:37:08.935046+00:00",
-"metadata": {"graph_id": "agent"},
-"status": "idle",
-"config": {},
-"values": {
-"messages": [
-{
-"content": "hello",
-"additional_kwargs": {},
-"response_metadata": {},
-"type": "human",
-"name": null,
-"id": "8701f3be-959c-4b7c-852f-c2160699b4ab",
-"example": false
-},
+```json
 {
-"content": "Hello! How can I assist you today?",
-"additional_kwargs": {},
-"response_metadata": {},
-"type": "ai",
-"name": null,
-"id": "4d8ea561-7ca1-409a-99f7-6b67af3e1aa3",
-"example": false,
-"tool_calls": [],
-"invalid_tool_calls": [],
-"usage_metadata": null
-}
-]
-}
+  "thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
+  "created_at": "2025-05-12T15:37:08.935038+00:00",
+  "updated_at": "2025-05-12T15:37:08.935046+00:00",
+  "metadata": {
+    "graph_id": "agent"
+  },
+  "status": "idle",
+  "config": {},
+  "values": {
+    "messages": [
+      {
+        "content": "hello",
+        "additional_kwargs": {},
+        "response_metadata": {},
+        "type": "human",
+        "name": null,
+        "id": "8701f3be-959c-4b7c-852f-c2160699b4ab",
+        "example": false
+      },
+      {
+        "content": "Hello! How can I assist you today?",
+        "additional_kwargs": {},
+        "response_metadata": {},
+        "type": "ai",
+        "name": null,
+        "id": "4d8ea561-7ca1-409a-99f7-6b67af3e1aa3",
+        "example": false,
+        "tool_calls": [],
+        "invalid_tool_calls": [],
+        "usage_metadata": null
+      }
+    ]
+  }
 }
 ```
 
@@ -354,20 +356,24 @@ curl --request POST \
 ```
 </CodeGroup>
 
-For more information, refer to the @[Python][ThreadsClient.search] and @[JS][ThreadsClient.search] SDK docs, or the @[REST API][ThreadsAPI.search] reference.
+For more information, refer to the @[Python][ThreadsClient.search] and @[JS][ThreadsClient.search] SDK docs, or the [REST API](/langsmith/agent-server-api/threads/search-threads) reference.
 
 Output:
 
-```
+```json
 [
-{
-'thread_id': 'cacf79bb-4248-4d01-aabc-938dbd60ed2c',
-'created_at': '2024-08-14T17:36:38.921660+00:00',
-'updated_at': '2024-08-14T17:36:38.921660+00:00',
-'metadata': {'graph_id': 'agent'},
-'status': 'idle',
-'config': {'configurable': {}}
-}
+  {
+    "thread_id": "cacf79bb-4248-4d01-aabc-938dbd60ed2c",
+    "created_at": "2024-08-14T17:36:38.921660+00:00",
+    "updated_at": "2024-08-14T17:36:38.921660+00:00",
+    "metadata": {
+      "graph_id": "agent"
+    },
+    "status": "idle",
+    "config": {
+      "configurable": {}
+    }
+  }
 ]
 ```
 
@@ -398,16 +404,20 @@ curl --request POST \
 
 Output:
 
-```
+```json
 [
-{
-'thread_id': 'cacf79bb-4248-4d01-aabc-938dbd60ed2c',
-'created_at': '2024-08-14T17:36:38.921660+00:00',
-'updated_at': '2024-08-14T17:36:38.921660+00:00',
-'metadata': {'graph_id': 'agent'},
-'status': 'idle',
-'config': {'configurable': {}}
-}
+  {
+    "thread_id": "cacf79bb-4248-4d01-aabc-938dbd60ed2c",
+    "created_at": "2024-08-14T17:36:38.921660+00:00",
+    "updated_at": "2024-08-14T17:36:38.921660+00:00",
+    "metadata": {
+      "graph_id": "agent"
+    },
+    "status": "idle",
+    "config": {
+      "configurable": {}
+    }
+  }
 ]
 ```
 
@@ -463,18 +473,22 @@ curl --request GET \
 
 Output:
 
-```
+```json
 {
-'thread_id': 'cacf79bb-4248-4d01-aabc-938dbd60ed2c',
-'created_at': '2024-08-14T17:36:38.921660+00:00',
-'updated_at': '2024-08-14T17:36:38.921660+00:00',
-'metadata': {'graph_id': 'agent'},
-'status': 'idle',
-'config': {'configurable': {}}
+  "thread_id": "cacf79bb-4248-4d01-aabc-938dbd60ed2c",
+  "created_at": "2024-08-14T17:36:38.921660+00:00",
+  "updated_at": "2024-08-14T17:36:38.921660+00:00",
+  "metadata": {
+    "graph_id": "agent"
+  },
+  "status": "idle",
+  "config": {
+    "configurable": {}
+  }
 }
 ```
 
-For more information, refer to the @[Python][ThreadsClient.get] and @[JS][ThreadsClient.get] SDK docs, or the @[REST API][ThreadsAPI.get] reference.
+For more information, refer to the @[Python][ThreadsClient.get] and @[JS][ThreadsClient.get] SDK docs, or the [REST API](/langsmith/agent-server-api/threads/get-thread) reference.
 
 ### Inspect thread state
 
@@ -502,70 +516,70 @@ curl --request GET \
 
 Output:
 
-```
-{
-"values": {
-"messages": [
+```json
 {
-"content": "hello",
-"additional_kwargs": {},
-"response_metadata": {},
-"type": "human",
-"name": null,
-"id": "8701f3be-959c-4b7c-852f-c2160699b4ab",
-"example": false
-},
-{
-"content": "Hello! How can I assist you today?",
-"additional_kwargs": {},
-"response_metadata": {},
-"type": "ai",
-"name": null,
-"id": "4d8ea561-7ca1-409a-99f7-6b67af3e1aa3",
-"example": false,
-"tool_calls": [],
-"invalid_tool_calls": [],
-"usage_metadata": null
-}
-]
-},
-"next": [],
-"tasks": [],
-"metadata": {
-"thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
-"checkpoint_id": "1f02f46f-7308-616c-8000-1b158a9a6955",
-"graph_id": "agent_with_quite_a_long_name",
-"source": "update",
-"step": 1,
-"writes": {
-"call_model": {
-"messages": [
-{
-"content": "Hello! How can I assist you today?",
-"type": "ai"
-}
-]
-}
-},
-"parents": {}
-},
-"created_at": "2025-05-12T15:37:09.008055+00:00",
-"checkpoint": {
-"checkpoint_id": "1f02f46f-733f-6b58-8001-ea90dcabb1bd",
-"thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
-"checkpoint_ns": ""
-},
-"parent_checkpoint": {
-"checkpoint_id": "1f02f46f-7308-616c-8000-1b158a9a6955",
-"thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
-"checkpoint_ns": ""
-},
-"checkpoint_id": "1f02f46f-733f-6b58-8001-ea90dcabb1bd",
-"parent_checkpoint_id": "1f02f46f-7308-616c-8000-1b158a9a6955"
+  "values": {
+    "messages": [
+      {
+        "content": "hello",
+        "additional_kwargs": {},
+        "response_metadata": {},
+        "type": "human",
+        "name": null,
+        "id": "8701f3be-959c-4b7c-852f-c2160699b4ab",
+        "example": false
+      },
+      {
+        "content": "Hello! How can I assist you today?",
+        "additional_kwargs": {},
+        "response_metadata": {},
+        "type": "ai",
+        "name": null,
+        "id": "4d8ea561-7ca1-409a-99f7-6b67af3e1aa3",
+        "example": false,
+        "tool_calls": [],
+        "invalid_tool_calls": [],
+        "usage_metadata": null
+      }
+    ]
+  },
+  "next": [],
+  "tasks": [],
+  "metadata": {
+    "thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
+    "checkpoint_id": "1f02f46f-7308-616c-8000-1b158a9a6955",
+    "graph_id": "agent_with_quite_a_long_name",
+    "source": "update",
+    "step": 1,
+    "writes": {
+      "call_model": {
+        "messages": [
+          {
+            "content": "Hello! How can I assist you today?",
+            "type": "ai"
+          }
+        ]
+      }
+    },
+    "parents": {}
+  },
+  "created_at": "2025-05-12T15:37:09.008055+00:00",
+  "checkpoint": {
+    "checkpoint_id": "1f02f46f-733f-6b58-8001-ea90dcabb1bd",
+    "thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
+    "checkpoint_ns": ""
+  },
+  "parent_checkpoint": {
+    "checkpoint_id": "1f02f46f-7308-616c-8000-1b158a9a6955",
+    "thread_id": "f15d70a1-27d4-4793-a897-de5609920b7d",
+    "checkpoint_ns": ""
+  },
+  "checkpoint_id": "1f02f46f-733f-6b58-8001-ea90dcabb1bd",
+  "parent_checkpoint_id": "1f02f46f-7308-616c-8000-1b158a9a6955"
 }
 ```
 
-For more information, refer to the @[Python][ThreadsClient.get_state] and @[JS][ThreadsClient.get_state] SDK docs, or the @[REST API][ThreadsAPI.get_state] reference.
+For more information, refer to the @[Python][ThreadsClient.get_state] and @[JS][ThreadsClient.get_state] SDK docs, or the [REST API](/langsmith/agent-server-api/threads/get-thread-state) reference.
 
 Optionally, to view the state of a thread at a given checkpoint, pass in the checkpoint ID. This is useful for inspecting the thread state at a specific point in its execution history.
 
@@ -666,7 +680,7 @@ This method is particularly useful for:
 - Auditing conversation history and state changes.
 - Replaying or analyzing past interactions.
 
-For more information, refer to the @[Python][ThreadsClient.get_history] and @[JS][ThreadsClient.get_history] SDK docs, or the @[REST API][ThreadsAPI.get_history] reference.
+For more information, refer to the @[Python][ThreadsClient.get_history] and @[JS][ThreadsClient.get_history] SDK docs, or the [REST API](/langsmith/agent-server-api/threads/get-thread-history) reference.
 
 </Tab>
 <Tab title="UI">
