Skip to content

Commit 69dafba

Browse files
authored
chore: update sdk and api wording (#1051)
1 parent 409540a commit 69dafba

File tree

4 files changed

+76
-40
lines changed

4 files changed

+76
-40
lines changed

src/content/Docs/api-documentation/console-api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: "Deploy on Akash programmatically without managing wallets or priva
99

1010
**Deploy on Akash programmatically using the Console Managed Wallet API.**
1111

12-
The Managed Wallet API allows you to create and manage deployments programmatically without managing your own wallet or private keys.
12+
The Managed Wallet API is part of the **Console API**: it lets you create and manage deployments with Console-managed wallets (no private keys). For querying the blockchain directly, use [Node API Layer](/docs/node-operators/architecture/api-layer)—the Console API is not an Akash node.
1313

1414
---
1515

src/content/Docs/api-documentation/getting-started/index.md

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,76 +7,88 @@ linkTitle: "Getting Started"
77
description: "Integrate Akash Network into your applications with SDKs and APIs"
88
---
99

10-
**Programmatic access to Akash Network with blockchain SDKs, deployment REST APIs, or public data endpoints.**
10+
**Programmatic access to Akash Network: query the chain directly, use indexed data and managed wallets, or integrate with the chain SDK.**
1111

12-
Choose your integration method:
13-
- **Akash Blockchain SDK** - Full blockchain integration with AKT/USDC payments
14-
- **Akash Deployment REST API** - Simple REST API with credit card payments
15-
- **Akash REST API** - Public endpoints for querying providers and GPU availability
12+
Choose the right API for your use case:
13+
14+
- **Blockchain REST/RPC** — Query data from the chain directly (gRPC, REST, RPC on an Akash node). Use this when your app needs to read chain state or submit transactions to the blockchain.
15+
- **Console API** — Query indexed data (stats, deployments, providers) and manage deployments for Console managed wallets. This is **not** a node: it serves aggregated/indexed data and managed-wallet flows, not raw chain queries.
16+
- **Chain SDK** — Integrate with Akash in Go or TypeScript/JavaScript. Use your own wallet (AKT/USDC) or custodial flows.
1617

1718
---
1819

20+
## Blockchain REST/RPC (query the chain directly)
21+
22+
Query blockchain state and submit transactions via an Akash node. Use this when you need to read chain data (balances, deployments, validators, etc.) or broadcast transactions — not when you only need indexed stats or managed-wallet deployments.
23+
24+
- **[Node API Layer](/docs/node-operators/architecture/api-layer)** — gRPC, REST (gRPC-Gateway), and CometBFT RPC on an Akash node
25+
- Run your own node or use a public RPC endpoint to query the chain directly
26+
1927
## Akash Blockchain SDK
2028

21-
Build deployment and provider management capabilities directly into your applications:
29+
Build deployment and provider management into your app with the official chain SDK (Go and TypeScript/JavaScript). Integrate with the blockchain using your own wallet or custodial wallets; pay with AKT or USDC.
2230

2331
- **[Akash SDK](/docs/api-documentation/sdk)** - Official Go and JavaScript/TypeScript SDKs
2432
- **[Installation Guide](/docs/api-documentation/sdk/installation)** - Get started with SDK installation
2533
- **[Quick Start](/docs/api-documentation/sdk/quick-start)** - Deploy your first application programmatically
2634
- **[API Reference](/docs/api-documentation/sdk/api-reference)** - Complete SDK documentation
2735
- **[Examples](/docs/api-documentation/sdk/examples)** - Code examples for common tasks
2836

29-
## Akash Deployment REST API
30-
31-
Deploy to Akash using credit cards instead of crypto:
37+
## Console API (indexed data & managed wallets)
3238

33-
- **[Managed Wallet API](/docs/api-documentation/console-api)** - REST API for credit card deployments via Console
34-
- No wallet management required - Console handles the blockchain layer
35-
- Pay with credit card instead of AKT or USDC
39+
The Console API serves **indexed data** (providers, stats, deployments) and **managed wallet** deployment flows. It is **not** an Akash node — do not use it to query chain state or broadcast transactions. Use it for dashboards, provider/GPU discovery, and credit-card deployments via Console.
3640

37-
## Akash REST API
41+
**Indexed data (read-only, no auth):**
3842

39-
Query Akash Network data without authentication:
40-
41-
- **[REST API Overview](/docs/api-documentation/rest-api)** - Public endpoints for network data
43+
- **[Console API — Network Data](/docs/api-documentation/rest-api)** - Public endpoints for providers, GPU availability, and network statistics (indexed data; base URL: `console-api.akash.network`)
4244
- **[Providers API](/docs/api-documentation/rest-api/providers-api)** - List and query provider details, hardware specs, and availability
4345
- **[GPU Availability Guide](/docs/api-documentation/rest-api/gpu-availability-guide)** - Find GPU resources across the network
4446

47+
**Managed wallets (API key required):**
48+
49+
- **[Managed Wallet API](/docs/api-documentation/console-api)** - Create and manage deployments with Console-managed wallets; pay with credit card. No wallet or private key management.
50+
4551
---
4652

4753
## Use Cases
4854

49-
### When to Use Akash Blockchain SDK
55+
### When to use Blockchain REST/RPC (node)
56+
- Your app needs to query chain state (balances, deployments, validators, etc.) directly
57+
- You need to broadcast transactions to the chain
58+
- You are building tooling that talks to an Akash node (gRPC, REST, or RPC)
59+
60+
### When to use the Akash Blockchain SDK
5061
- Full blockchain integration with your own wallet
5162
- Pay with AKT or USDC cryptocurrency
5263
- Build deployment automation tools
5364
- Create custom deployment workflows
5465
- Build provider management dashboards
5566
- Develop monitoring and analytics tools
5667

57-
### When to Use Akash Deployment REST API
68+
### When to use Console API (managed wallets)
5869
- Accept credit card payments for deployments
5970
- Deploy without managing wallets or crypto
6071
- Build SaaS platforms that need simple payments
6172
- Create user-friendly deployment interfaces
6273
- Offer Akash deployments to non-crypto users
6374

64-
### When to Use Akash REST API
65-
- Query provider availability, hardware specs, and GPU models
75+
### When to use Console API (indexed network data)
76+
- Query provider availability, hardware specs, and GPU models (indexed data)
6677
- Build network dashboards and analytics tools
6778
- Monitor provider uptime and capacity
6879
- Find GPU resources for your workloads
69-
- No authentication or payment setup needed
80+
- No authentication or payment setup needed (public read-only endpoints)
7081

7182
---
7283

7384
## Getting Started
7485

7586
**Choose your integration method:**
7687

77-
- **Blockchain integration?**[Use the Blockchain SDK](/docs/api-documentation/sdk) - Pay with AKT/USDC, manage your own wallet
78-
- **Credit card payments?**[Use the Deployment REST API](/docs/api-documentation/console-api) - No wallet needed, pay with credit card
79-
- **Query network data?**[Use the REST API](/docs/api-documentation/rest-api) - Public endpoints, no authentication required
88+
- **Query the chain directly (node)?**[Node API Layer](/docs/node-operators/architecture/api-layer) - gRPC, REST, RPC on an Akash node
89+
- **Blockchain integration in code?**[Use the Blockchain SDK](/docs/api-documentation/sdk) - Pay with AKT/USDC, manage your own wallet
90+
- **Credit card deployments?**[Managed Wallet API](/docs/api-documentation/console-api) - No wallet needed, pay with credit card via Console
91+
- **Indexed network data (providers, GPU, stats)?**[Console API — Network Data](/docs/api-documentation/rest-api) - Public endpoints, not a node
8092

8193
**Need help?**
8294

src/content/Docs/api-documentation/rest-api/index.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
---
22
categories: ["API Documentation", "REST API"]
3-
tags: ["REST API", "Providers", "GPU", "Public API"]
3+
tags: ["REST API", "Providers", "GPU", "Public API", "Console API"]
44
weight: 4
5-
title: "Akash REST API"
6-
linkTitle: "Akash REST API"
7-
description: "Public REST API endpoints for querying Akash Network data including providers and GPU availability"
5+
title: "Console API — Network Data"
6+
linkTitle: "Console API — Network Data"
7+
description: "Public Console API endpoints for indexed network data: providers, GPU availability, and statistics (not a node)"
88
---
99

10-
**Public, read-only endpoints for querying Akash Network data. No authentication required.**
10+
**Public, read-only Console API for indexed network data. No authentication required.**
11+
12+
This API serves **indexed data** (providers, GPU availability, network stats). It is **not** an Akash node — do not use it to query chain state or broadcast transactions. For querying the blockchain directly, use [Node API Layer (gRPC, REST, RPC)](/docs/node-operators/architecture/api-layer).
1113

1214
Base URL: `https://console-api.akash.network`
1315

@@ -42,9 +44,10 @@ curl https://console-api.akash.network/v1/providers/akash1u5cdg7k3gl43mukca4aeul
4244

4345
## Key Features
4446

47+
- **Indexed data, not a node** — Aggregated network data from Console; for raw chain queries use [Node API Layer](/docs/node-operators/architecture/api-layer)
4548
- **No authentication** — All endpoints are public and read-only
4649
- **JSON responses** — Standard REST API returning JSON
47-
- **Provider data** — Hardware specs, GPU models, uptime, location, and real-time capacity
50+
- **Provider data** — Hardware specs, GPU models, uptime, location, and real-time capacity (indexed)
4851
- **Network statistics** — Active/available/pending resources across the network
4952

5053
---

src/pages/docs/api-documentation/getting-started.astro

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,17 +78,38 @@ const integrationOptions = [
7878
},
7979
],
8080
},
81+
{
82+
icon: codeIcon,
83+
title: "Blockchain REST/RPC",
84+
description: "Query the chain directly via an Akash node (gRPC, REST, RPC). For chain state and transactions.",
85+
link: "/docs/node-operators/architecture/api-layer",
86+
linkText: "Node API Layer →",
87+
details: [
88+
{
89+
label: "Best for:",
90+
items: [
91+
"Querying chain state (balances, deployments, validators)",
92+
"Submitting transactions to the blockchain",
93+
"Tooling that talks to an Akash node",
94+
],
95+
},
96+
{
97+
label: "Note:",
98+
text: "Use a node endpoint; Console API is indexed data, not a node.",
99+
},
100+
],
101+
},
81102
{
82103
icon: globeIcon,
83-
title: "Akash REST API",
84-
description: "Query Akash Network data including providers, GPU availability, and network statistics",
104+
title: "Console API — Network Data",
105+
description: "Indexed data only: providers, GPU availability, stats. Not a node — do not use for chain queries.",
85106
link: "/docs/api-documentation/rest-api",
86-
linkText: "Explore REST API →",
107+
linkText: "Explore Console API (network data)",
87108
details: [
88109
{
89110
label: "Best for:",
90111
items: [
91-
"Querying provider availability and specs",
112+
"Querying provider availability and specs (indexed)",
92113
"Finding GPU resources on the network",
93114
"Building dashboards and analytics",
94115
"Network monitoring tools",
@@ -136,12 +157,12 @@ const sdkDocsCards = [
136157
},
137158
];
138159
139-
// Akash REST API Documentation Cards
160+
// Console API — Network Data (indexed) Documentation Cards
140161
const restApiCards = [
141162
{
142163
icon: globeIcon,
143-
title: "REST API Overview",
144-
description: "Public endpoints for querying Akash Network data",
164+
title: "Console API — Network Data",
165+
description: "Indexed data: providers, GPU, stats. Not a node.",
145166
link: "/docs/api-documentation/rest-api",
146167
},
147168
{
@@ -325,10 +346,10 @@ const helpLinks = [
325346
</div>
326347
</div>
327348

328-
<!-- Akash REST API Documentation -->
349+
<!-- Console API — Network Data (indexed) -->
329350
<div class="mt-12">
330351
<h2 class="mb-6 text-2xl font-bold text-foreground md:text-3xl">
331-
Akash REST API Documentation
352+
Console API — Network Data (indexed)
332353
</h2>
333354
<div class="grid grid-cols-1 gap-4 lg:grid-cols-3">
334355
{

0 commit comments

Comments
 (0)