[Docs] Replace custom API endpoint with OpenAPI component #7829
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,28 @@ | ||
| import { Tabs, TabsContent, TabsList, TabsTrigger, OpenApiEndpoint } from "@doc"; | ||
|
|
||
| # Chat API | ||
|
|
||
| The thirdweb AI chat API is a standard OpenAI-compatible chat completion API that allows you to interact with the thirdweb AI model, optimized for blockchain interactions. | ||
|
|
||
| - Query real-time data from the blockchain | ||
| - Analyze transactions | ||
| - Fetch token balances, prices and metadata | ||
| - Prepare any contract call or transaction for signing | ||
| - Prepare swaps from/to any token pair | ||
| - Deploy contracts | ||
| - Generate images | ||
| - Search the web | ||
| - And more! | ||
|
|
||
| You can use the API with the HTTP API directly, or with any OpenAI-compatible client library. | ||
|
|
||
| <Tabs defaultValue="api"> | ||
| <TabsList> | ||
| <TabsTrigger value="api">HTTP API</TabsTrigger> | ||
| <TabsTrigger value="openai">OpenAI Client</TabsTrigger> | ||
| </TabsList> | ||
| <TabsContent value="api"> | ||
| <OpenApiEndpoint path="/ai/chat" method="POST" specUrl="https://api.thirdweb-dev.com/openapi.json" /> | ||
| </TabsContent> | ||
| <TabsContent value="openai"> | ||
|
|
||
|
|
@@ -50,4 +47,9 @@ chat_completion = client.chat.completions.create( | |
| print(chat_completion) | ||
| ``` | ||
| </TabsContent> | ||
| </Tabs> | ||
|
|
||
| ### Going further | ||
|
|
||
| - [Handle streaming responses](/ai/chat/streaming) | ||
| - [Full API Reference](https://api.thirdweb-dev.com/reference#tag/ai/post/ai/chat) | ||
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,8 +13,8 @@ export const sidebar: SideBar = { | |
| icon: <ZapIcon />, | ||
| }, | ||
| { | ||
| name: "Streaming Responses", | ||
| href: "/ai/chat/streaming", | ||
| }, | ||
|
Comment on lines
+16
to
18
Contributor
There was a problem hiding this comment. 💡 Verification agent 🧩 Analysis chainRename to “Streaming Responses” looks good; verify route exists and unify API reference domain.
Script to check the page exists and to find any lingering Apply this diff to normalize the API Reference domain in this file: - href: "https://api.thirdweb-dev.com/reference#tag/ai/post/ai/chat",
+ href: "https://api.thirdweb.com/reference#tag/ai/post/ai/chat",🏁 Script executed: #!/bin/bash
set -euo pipefail
# Verify streaming page exists (any of TSX/MDX)
if test -d "apps/portal/src/app/ai/chat/streaming"; then
fd -t f . apps/portal/src/app/ai/chat/streaming
else
echo "Missing: apps/portal/src/app/ai/chat/streaming"
exit 1
fi
# Find dev-domain API references across repo
echo
echo "Occurrences of api.thirdweb-dev.com/reference:"
rg -n --hidden --no-ignore -e "api\.thirdweb-dev\.com/reference" || trueLength of output: 581 Confirm
• apps/portal/src/app/ai/sidebar.tsx (around line 21): - href: "https://api.thirdweb-dev.com/reference#tag/ai/post/ai/chat",
+ href: "https://api.thirdweb.com/reference#tag/ai/post/ai/chat",• apps/portal/src/app/ai/chat/page.mdx (around line 55): - [Full API Reference](https://api.thirdweb-dev.com/reference#tag/ai/post/ai/chat)
+ [Full API Reference](https://api.thirdweb.com/reference#tag/ai/post/ai/chat)
🤖 Prompt for AI Agents |
||
| { | ||
| name: "API Reference", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,14 @@ | ||
| import { OpenApiEndpoint, createMetadata } from "@doc"; | ||
|
|
||
| export const metadata = createMetadata({ | ||
| image: { | ||
| title: "Deploy contracts", | ||
| icon: "contracts", | ||
| }, | ||
| title: "Deploy Contracts", | ||
| description: "Deploy contracts on any EVM chain.", | ||
| }); | ||
|
|
||
| # Deploy Contracts | ||
|
|
||
| You can deploy contracts via CLI or programatically. | ||
|
|
@@ -16,8 +27,6 @@ You can also publish your contract to be deployable by anyone on any chain. | |
| npx thirdweb publish -k <project-secret-key> | ||
| ``` | ||
|
|
||
| ## Deploying via SDK | ||
|
|
||
| You can deploy contracts from ABI and bytecode. | ||
|
|
@@ -26,15 +35,15 @@ You can deploy contracts from ABI and bytecode. | |
| import { deployContract } from "thirdweb/deploys"; | ||
|
|
||
| const address = await deployContract({ | ||
| client, | ||
| chain, | ||
| bytecode: "0x...", | ||
| abi: contractAbi, | ||
| constructorParams: { | ||
| param1: "value1", | ||
| param2: 123, | ||
| }, | ||
| salt, // optional: salt enables deterministic deploys | ||
| }); | ||
| ``` | ||
|
|
||
|
|
@@ -44,14 +53,26 @@ Or alternatively, you can deploy a contract from a previously published contract | |
| import { deployPublishedContract } from "thirdweb/deploys"; | ||
|
|
||
| const address = await deployPublishedContract({ | ||
| client, | ||
| chain, | ||
| account, | ||
| contractId: "MyPublishedContract", | ||
| contractParams: { | ||
| param1: "value1", | ||
| param2: 123, | ||
| }, | ||
| publisher: "0x...", // optional, defaults to the thirdweb deployer | ||
| }); | ||
| ``` | ||
|
|
||
| ## Deploy via API | ||
|
|
||
| You can also deploy contracts via API by passing the contract bytecode and ABI. This will automatically verify the contract on block explorers and add it to your project dashboard. | ||
|
|
||
| <OpenApiEndpoint path="/v1/contracts" method="POST" /> | ||
|
|
||
| ## List all deployed contracts | ||
|
|
||
| You can list all deployed contracts for your project. | ||
|
|
||
| <OpenApiEndpoint path="/v1/contracts" method="GET" /> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ import { | |
| TabsList, | ||
| TabsTrigger, | ||
| TabsContent, | ||
| OpenApiEndpoint, | ||
| } from "@doc"; | ||
| import { | ||
| ReactIcon, | ||
|
|
@@ -31,27 +32,7 @@ Query and listen to contract events for any deployed contract on any EVM chain. | |
| </TabsList> | ||
|
|
||
| <TabsContent value="http"> | ||
| <OpenApiEndpoint path="/v1/contracts/{chainId}/{address}/events" method="GET" /> | ||
|
|
||
| </TabsContent> | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,7 @@ import { | |
| TabsList, | ||
| TabsTrigger, | ||
| TabsContent, | ||
| OpenApiEndpoint, | ||
| } from "@doc"; | ||
| import { | ||
| ReactIcon, | ||
|
|
@@ -67,89 +68,18 @@ Read, write, and deploy smart contracts on any EVM compatible blockchain. | |
| </TabsList> | ||
|
|
||
| <TabsContent value="http"> | ||
|
|
||
| ### Read from Contracts | ||
|
|
||
| You can efficiently read data from multiple functions or contracts in a single request. | ||
|
|
||
| <OpenApiEndpoint path="/v1/contracts/read" method="POST" /> | ||
|
|
||
| ### Write to Contracts | ||
|
|
||
| You can write multiple functions to multiple contracts on the same chain in a single request atomically, which will result in a single transaction for optimal gas efficiency. | ||
|
|
||
| <OpenApiEndpoint path="/v1/contracts/write" method="POST" /> | ||
|
|
||
| </TabsContent> | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Pinning
openapi-typesis fine; verify if it should be a devDependency and align versions workspace-wide.If
openapi-typesis only used for TypeScript types, prefer moving it todevDependenciesto keep production/runtime deps lean. Also ensure all packages pin the same version to avoid duplication.Run this script to (a) find all imports/usages of
openapi-typesand (b) report every package.json that declares it and where (dependencies vs devDependencies):🏁 Script executed:
Length of output: 4572
Move
openapi-typesto devDependencies and align versionsAll imports of
openapi-typesin the repo are type‐only (import type { OpenAPIV3[_1] }…), so it does not need to ship at runtime. Currently it’s declared in dependencies in two spots:• apps/playground-web/package.json (v12.1.3)
• apps/portal/package.json (v12.1.3)
Please:
"openapi-types": "12.1.3"from dependencies in both package.json files"openapi-types": "12.1.3"under devDependencies in both🤖 Prompt for AI Agents