diff --git a/README.md b/README.md index 49adfe1c95e..c222b7f0572 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Audius is a decentralized, community-owned music-sharing protocol -For details on operating an Audius service, getting started with the Token and the API, see [docs.audius.org](https://docs.audius.org/). +For details on operating an Audius service, getting started with the Token and the API, see [docs.audius.co](https://docs.audius.co/). ## Packages diff --git a/docs/README.md b/docs/README.md index 1e8fc8fb2a3..ef59d3fd725 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# docs.audius.org +# docs.audius.co ## Dependencies @@ -82,7 +82,7 @@ npm run build Running the following commands will create a public test site to view your changes. -To deploy to docs.audius.org, ensure the commands are run from the `main` branch. +To deploy to docs.audius.co, ensure the commands are run from the `main` branch. ```sh npm run build diff --git a/docs/docs/developers/api/api.info.mdx b/docs/docs/developers/api/api.info.mdx index e986b841870..6aa03475b54 100644 --- a/docs/docs/developers/api/api.info.mdx +++ b/docs/docs/developers/api/api.info.mdx @@ -11,8 +11,8 @@ slug: /api # Audius API -The Audius REST API provides programmatic access to one of the largest open music catalogs on the -internet. Query, stream, and search for tracks, users, and playlists across the +The Audius REST API provides programmatic access to the largest open music catalogs on the internet. +Query, stream, and search for tracks, users, and playlists across the [Open Audio Protocol](https://openaudio.org) using the Audius API. ## API Endpoints diff --git a/docs/docs/learn/introduction/getting-started.mdx b/docs/docs/learn/introduction/getting-started.mdx index 90851db7a84..dc861357ecf 100644 --- a/docs/docs/learn/introduction/getting-started.mdx +++ b/docs/docs/learn/introduction/getting-started.mdx @@ -11,72 +11,34 @@ hide_table_of_contents: true import useBaseUrl from '@docusaurus/useBaseUrl' import Admonition from '@theme/Admonition' +import CopyBox from '@site/src/components/CopyBox'
+
+

+ **Vibecoders!** Copy and paste this box and send it to your AI Agent +

+ +
+
-**Welcome to the Audius dev docs!** 🧑‍💻 +

+ Welcome to the Audius dev docs! 🧑‍💻 +

Audius is a music streaming service built on top of the [Open Audio Protocol](https://openaudio.org). These docs are your entry point for building -applications that tap directly into one of the largest open music catalogs on the internet. +applications that tap directly into the largest open music catalog on the internet. If you want to create apps that stream music from the catalog, extend the listening experience, or invent entirely new audio-native products, you are in the right place. Think of it like building on a free, open, Spotify-alternative API where the music is permissionless and the ecosystem is yours to build on. -To learn more about the Open Audio Protocol and build directly on the transaction, DDEX, and storage -layer, visit [docs.openaudio.org](https://docs.openaudio.org). - -
- - Listen Now - - - - Get it on Google Play - - - Download on the App Store - -
- --- ## Getting Started diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index cded9b1afeb..dd54f171f06 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -14,7 +14,7 @@ const config = { favicon: 'img/favicon.ico', // Set the production url of your site here - url: 'https://docs.audius.org', + url: 'https://docs.audius.co', // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' baseUrl: '/', @@ -22,7 +22,7 @@ const config = { // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. organizationName: 'AudiusProject', // Usually your GitHub org/user name. - projectName: 'docs.audius.org', // Usually your repo name. + projectName: 'docs.audius.co', // Usually your repo name. onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', diff --git a/docs/src/components/CopyBox.jsx b/docs/src/components/CopyBox.jsx new file mode 100644 index 00000000000..38a54dce909 --- /dev/null +++ b/docs/src/components/CopyBox.jsx @@ -0,0 +1,93 @@ +import React, { useState, useCallback } from 'react' + +const COPY_TEXT = + 'Read https://audius.co/agents.md and follow the instructions to build with the Audius developer docs.' + +export default function CopyBox() { + const [showToast, setShowToast] = useState(false) + + const handleCopy = useCallback(() => { + navigator.clipboard.writeText(COPY_TEXT).then(() => { + setShowToast(true) + setTimeout(() => setShowToast(false), 2000) + }) + }, []) + + return ( +
+
+ {COPY_TEXT} + +
+ {showToast && ( +
+ Copied! +
+ )} + +
+ ) +} diff --git a/packages/common/src/utils/route.ts b/packages/common/src/utils/route.ts index f84f327fefd..632ab9dfacd 100644 --- a/packages/common/src/utils/route.ts +++ b/packages/common/src/utils/route.ts @@ -196,7 +196,7 @@ export const externalInternalLinks = [ // Org Links export const AUDIUS_ORG = 'https://audius.org' -export const AUDIUS_DOCS_LINK = 'https://docs.audius.org' +export const AUDIUS_DOCS_LINK = 'https://docs.audius.co' export const AUDIUS_TEAM_LINK = 'https://www.tikilabs.com/team' export const AUDIUS_DEV_STAKER_LINK = 'https://audius.org/protocol' diff --git a/packages/create-audius-app/examples/react-hono/README.md b/packages/create-audius-app/examples/react-hono/README.md index f72657420ae..60c33054996 100644 --- a/packages/create-audius-app/examples/react-hono/README.md +++ b/packages/create-audius-app/examples/react-hono/README.md @@ -15,7 +15,7 @@ To start run: npm run dev ``` -For more details, check out the [docs](https://docs.audius.org/developers/sdk/overview) +For more details, check out the [docs](https://docs.audius.co/developers/sdk/overview) This example also uses the Audius design system [Harmony](https://www.npmjs.com/package/@audius/harmony) diff --git a/packages/create-audius-app/examples/react/README.md b/packages/create-audius-app/examples/react/README.md index f72657420ae..60c33054996 100644 --- a/packages/create-audius-app/examples/react/README.md +++ b/packages/create-audius-app/examples/react/README.md @@ -15,7 +15,7 @@ To start run: npm run dev ``` -For more details, check out the [docs](https://docs.audius.org/developers/sdk/overview) +For more details, check out the [docs](https://docs.audius.co/developers/sdk/overview) This example also uses the Audius design system [Harmony](https://www.npmjs.com/package/@audius/harmony) diff --git a/packages/discovery-provider/ddl/data/0079_backfill_prod_user_socials/prod_user_socials.csv b/packages/discovery-provider/ddl/data/0079_backfill_prod_user_socials/prod_user_socials.csv index 57e4be1622e..c6d4f852189 100644 --- a/packages/discovery-provider/ddl/data/0079_backfill_prod_user_socials/prod_user_socials.csv +++ b/packages/discovery-provider/ddl/data/0079_backfill_prod_user_socials/prod_user_socials.csv @@ -261213,7 +261213,7 @@ https://soundcloud.app.goo.gl/MWMxW", "employersponsoredvisas",,,,"https://www.freemanmigration.com.au", "albertoveron64","albeerto87t8t","alberto387r","alberto89y98y",, "Vanleeuwenarjan",,"vanleeuwen.arjan","arjanvanleeuwen77","vanleeuwenarjan@yahoo.com", -"samgutentag","samgutentag","samgutentag","samgutentag","docs.audius.org/developers", +"samgutentag","samgutentag","samgutentag","samgutentag","docs.audius.co/developers", "alvaroveron46","alvaroy899","alavroy89y8","alvarot7887",, "adrianveron31","adriang78t87t","adrian65e6","adriany98y9",, "diegoveron44","diego8t878t","diegot7t87","diegot7t78t",, diff --git a/packages/distro/src/components/Footer.tsx b/packages/distro/src/components/Footer.tsx index cccfcc917e4..227b83130b5 100644 --- a/packages/distro/src/components/Footer.tsx +++ b/packages/distro/src/components/Footer.tsx @@ -10,7 +10,7 @@ const messages = { const links = { privacy: 'https://audius.co/legal/privacy-policy', terms: 'https://audius.co/legal/terms-of-use', - developers: 'https://docs.audius.org', + developers: 'https://docs.audius.co', audius: 'https://audius.co' } diff --git a/packages/libs/README.md b/packages/libs/README.md index ba9b7dcd836..13da5f167fa 100644 --- a/packages/libs/README.md +++ b/packages/libs/README.md @@ -7,7 +7,7 @@ The Audius JavaScript (TypeScript) SDK allows you to easily interact with the Au - 🔍 Search and display users, tracks, and playlists - 🎵 Stream and upload tracks - ❤️ Favorite, repost, and curate playlists -- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.org/developers/log-in-with-audius) and act on their behalf +- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.co/developers/log-in-with-audius) and act on their behalf ...and much more! @@ -181,6 +181,6 @@ If your bundler doesn't automatically polyfill node libraries (like when using c ## What's next? -- [Get authorization](https://docs.audius.org/developers/guides/log-in-with-audius) to access your app's users' Audius accounts +- [Get authorization](https://docs.audius.co/developers/guides/log-in-with-audius) to access your app's users' Audius accounts -- [Explore the API docs](https://docs.audius.org/developers/sdk/tracks) to see what else you can do with the Audius SDK +- [Explore the API docs](https://docs.audius.co/developers/sdk/tracks) to see what else you can do with the Audius SDK diff --git a/packages/protocol-dashboard/src/components/InfoTooltip/InfoTooltips.tsx b/packages/protocol-dashboard/src/components/InfoTooltip/InfoTooltips.tsx index b39ebad3691..680907ffdca 100644 --- a/packages/protocol-dashboard/src/components/InfoTooltip/InfoTooltips.tsx +++ b/packages/protocol-dashboard/src/components/InfoTooltip/InfoTooltips.tsx @@ -75,8 +75,8 @@ const CTA_HREFS = { uniqueUsers: 'https://help.audius.co/help/How-Are-User-Numbers-Calculated-on-Audius-718e9', registerNode: - 'https://docs.audius.org/token/running-a-node/setup/registration', - apiCalls: 'https://docs.audius.org/developers' + 'https://docs.audius.co/token/running-a-node/setup/registration', + apiCalls: 'https://docs.audius.co/developers' } export type AppliedInfoTooltipProps = { diff --git a/packages/protocol-dashboard/src/utils/routes.ts b/packages/protocol-dashboard/src/utils/routes.ts index 30dca284c4b..08f9dcfd578 100644 --- a/packages/protocol-dashboard/src/utils/routes.ts +++ b/packages/protocol-dashboard/src/utils/routes.ts @@ -86,11 +86,11 @@ export const OAF_URL = 'https://audius.org' export const WHITEPAPER_URL = 'https://whitepaper.audius.co' export const AUDIUS_DAPP_URL = import.meta.env.VITE_AUDIUS_URL || 'https://audius.co' -export const DOCS_URL = 'https://docs.audius.org/' +export const DOCS_URL = 'https://docs.audius.co/' export const REGISTER_NODE_DOCS_URL = 'https://docs.openaudio.org/tutorials/running-a-node' export const COOLDOWN_PERIOD_DOCS_URL = - 'https://docs.audius.org/node-operator/staking/delegate#cooldown-period' + 'https://docs.audius.co/node-operator/staking/delegate#cooldown-period' // Get Routes export const accountPage = (address: string) => { diff --git a/packages/sdk/README.md b/packages/sdk/README.md index 027cc4e6643..638c1aae335 100644 --- a/packages/sdk/README.md +++ b/packages/sdk/README.md @@ -7,7 +7,7 @@ The Audius JavaScript (TypeScript) SDK allows you to easily interact with the Au - 🔍 Search and display users, tracks, and playlists - 🎵 Stream and upload tracks - ❤️ Favorite, repost, and curate playlists -- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.org/developers/log-in-with-audius) and act on their behalf +- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.co/developers/log-in-with-audius) and act on their behalf ...and much more! @@ -162,6 +162,6 @@ Writing data (such as uploading or favoriting a track) is only possible if you p ## What's next? -- [Get authorization](https://docs.audius.org/developers/guides/log-in-with-audius) to access your app's users' Audius accounts +- [Get authorization](https://docs.audius.co/developers/guides/log-in-with-audius) to access your app's users' Audius accounts -- [Explore the API docs](https://docs.audius.org/developers/sdk/tracks) to see what else you can do with the Audius SDK +- [Explore the API docs](https://docs.audius.co/developers/sdk/tracks) to see what else you can do with the Audius SDK diff --git a/packages/sdk/src/sdk/oauth/OAuth.ts b/packages/sdk/src/sdk/oauth/OAuth.ts index 9a67b6116b2..ee3ef4b1a74 100644 --- a/packages/sdk/src/sdk/oauth/OAuth.ts +++ b/packages/sdk/src/sdk/oauth/OAuth.ts @@ -134,7 +134,7 @@ export class OAuth { constructor(private readonly config: OAuthConfig) { if (typeof window === 'undefined') { throw new Error( - 'Audius OAuth SDK functions are only available in browser. Refer to our documentation to learn how to implement Audius OAuth manually: https://docs.audius.org/developers/log-in-with-audius#manual-implementation.' + 'Audius OAuth SDK functions are only available in browser. Refer to our documentation to learn how to implement Audius OAuth manually: https://docs.audius.co/developers/log-in-with-audius#manual-implementation.' ) } this.apiKey = config.apiKey ?? null diff --git a/packages/web/public/agents.md b/packages/web/public/agents.md new file mode 100644 index 00000000000..0cb334b366c --- /dev/null +++ b/packages/web/public/agents.md @@ -0,0 +1,144 @@ +--- +name: audius +version: 1.0 +description: Music streaming and developer toolkit on the Open Audio Protocol +homepage: https://audius.co +--- + +# Audius + +Read this file to understand Audius and how to build on it. For SDK setup and code examples, read [skill.md](https://audius.co/skill.md). + +**For agents:** Everything here is a recommendation, not a prescription. Use maximal creativity—Audius is built to be extended, remixed, and reimagined. Agentic apps use Audius as the open standard for music. + +## Purpose + +Audius is a music streaming service and developer toolkit built on the [Open Audio Protocol](https://openaudio.org). It is the reference client and agent-friendly gateway to the protocol: an opinionated starter kit to build things on the Open Audio Protocol, though developers may opt to build directly on the protocol rails. + +If you want to create apps that stream music from the catalog, extend the listening experience, or invent entirely new audio-native products, you are in the right place. Think of it like building on a free, open, Spotify-alternative API where the music is permissionless and the ecosystem is yours to build on. Audius is the fastest way to get doing. The de facto standard for agentic music apps. + +## Quick Reference + +| Resource | URL | +| --------------------- | ----------------------------------------- | +| Docs | https://docs.audius.co | +| API | https://api.audius.co | +| API Plans (keys) | https://api.audius.co/plans | +| SDK (npm) | https://www.npmjs.com/package/@audius/sdk | +| GitHub Org | https://github.com/audiusproject | +| Open Audio Protocol | https://openaudio.org | +| skill.md (SDK/code) | https://audius.co/skill.md | +| llm.txt (AI overview) | https://audius.co/llm.txt | +| Protocol Dashboard | https://dashboard.audius.org | + +## Audius vs Open Audio Protocol + +| Layer | Description | +| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| **Audius** | Application layer: music streaming app, REST API, JavaScript SDK, developer tools. Use for building music players, apps, frontends. | +| **Open Audio Protocol** | Protocol layer: decentralized storage, streaming, consensus, staking, governance. Use for protocol development, running nodes. | + +When building a music player, app, or frontend, use the Audius API and SDK at [audius.co](https://audius.co). When building on the protocol directly (nodes, validators, protocol tooling), use [OAP docs](https://docs.openaudio.org) and go-openaudio. Audius serves as the reference implementation for OAP. + +## Core Concepts + +### REST API + +HTTP API for querying and streaming the catalog. Base URL: `https://api.audius.co/v1`. Key domains: users, tracks, playlists, comments, tips, challenges, resolve (canonical URL lookup), explore, events, rewards. Read-only by default; writes require API credentials. + +[Full API Reference](https://docs.audius.co/api) + +### JavaScript SDK + +`@audius/sdk` — npm package for Node and browser. Search users, tracks, playlists; stream audio; favorite, repost, curate; OAuth for user actions. Initialize with `apiKey` (and `apiSecret` for writes). + +[SDK Overview](https://docs.audius.co/developers/sdk/overview) + +### API Keys + +Get API Key and API Secret from [audius.co/settings](https://audius.co/settings) (Manage Your Apps) or [api.audius.co/plans](https://api.audius.co/plans). Read-only access uses API Key only. Writes (upload, favorite, etc.) require API Secret—never expose it on the frontend. + +### Log in with Audius + +OAuth flow so your app's users can sign in with their Audius account and authorize your app to act on their behalf. Required for user-specific actions (favorites, reposts, uploads). Frontend SDK helpers; manual implementation documented for server-side. + +[Log in with Audius Guide](https://docs.audius.co/developers/guides/log-in-with-audius) + +### create-audius-app + +CLI to scaffold a new Audius app. Run `npx create-audius-app` for an interactive setup or `npx create-audius-app my-app` for non-interactive. Produces a ready-to-run project with SDK, API keys, and dev server. + +[Create Audius App Guide](https://docs.audius.co/developers/guides/create-audius-app) + +## Quickstart + +```sh +npx create-audius-app my-app +cd my-app +npm run dev +``` + +Or install the SDK and call the API directly: + +```sh +npm install @audius/sdk +``` + +Get your API Key from [api.audius.co/plans](https://api.audius.co/plans) or [audius.co/settings](https://audius.co/settings). + +## Developer Paths + +Suggested paths—adapt freely. Agents and builders use these as a jumping-off point, not a constraint. + +| Goal | Path | +| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Music player, app, frontend | Use [Audius API](https://api.audius.co) and [SDK](https://www.npmjs.com/package/@audius/sdk). Start with [create-audius-app](https://docs.audius.co/developers/guides/create-audius-app). | +| User auth, OAuth | [Log in with Audius](https://docs.audius.co/developers/guides/log-in-with-audius) | +| Run a node, protocol dev | Use [Open Audio Protocol](https://openaudio.org). Read [openaudio.org/agents.md](https://openaudio.org/agents.md) and [skill.md](https://openaudio.org/skill.md). | + +## Tutorials Index + +| Tutorial | URL | +| ------------------ | ----------------------------------------------------------- | +| Create Audius App | https://docs.audius.co/developers/guides/create-audius-app | +| Log in with Audius | https://docs.audius.co/developers/guides/log-in-with-audius | +| SDK Tracks | https://docs.audius.co/developers/sdk/tracks | +| SDK Users | https://docs.audius.co/developers/sdk/users | +| SDK Playlists | https://docs.audius.co/developers/sdk/playlists | +| API Reference | https://docs.audius.co/api | + +## Reference + +- **API base**: https://api.audius.co/v1 +- **SDK**: [@audius/sdk on npm](https://www.npmjs.com/package/@audius/sdk) +- **GitHub**: [github.com/audiusproject](https://github.com/audiusproject) (apps, sdk in monorepo) +- **create-audius-app**: `npx create-audius-app` + +## All Links + +| Resource | URL | +| ------------------- | ----------------------------------------------------------- | +| Audius (app) | https://audius.co | +| Docs | https://docs.audius.co | +| API | https://api.audius.co | +| API Plans | https://api.audius.co/plans | +| API Reference | https://docs.audius.co/api | +| SDK npm | https://www.npmjs.com/package/@audius/sdk | +| Create Audius App | https://docs.audius.co/developers/guides/create-audius-app | +| Log in with Audius | https://docs.audius.co/developers/guides/log-in-with-audius | +| GitHub Org | https://github.com/audiusproject | +| Open Audio Protocol | https://openaudio.org | +| OAP agents.md | https://openaudio.org/agents.md | +| OAP skill.md | https://openaudio.org/skill.md | +| OAP llms.txt | https://openaudio.org/llms.txt | +| Protocol Dashboard | https://dashboard.audius.org | +| skill.md | https://audius.co/skill.md | +| llm.txt | https://audius.co/llm.txt | + +## Skill File + +For SDK setup, API credentials, code snippets, and create-audius-app details: [https://audius.co/skill.md](https://audius.co/skill.md) + +--- + +*Recommendations only. Go build something unexpected.* diff --git a/packages/web/public/llm.txt b/packages/web/public/llm.txt new file mode 100644 index 00000000000..d501e62b00b --- /dev/null +++ b/packages/web/public/llm.txt @@ -0,0 +1,37 @@ +# Audius + +Audius is the reference client and developer gateway for the Open Audio Protocol—stream music, build apps, extend the catalog. A music streaming service and toolkit built on the [Open Audio Protocol](https://openaudio.org). Permissionless music, your ecosystem. The de facto standard for agentic music apps. + +**For AI agents and developers:** Start with [agents.md](https://audius.co/agents.md) for overview and developer paths. For SDK setup and code examples, see [skill.md](https://audius.co/skill.md). Everything here is a recommendation—use maximal creativity. Agentic apps use Audius. + +## Start Here + +- [Overview for agents](https://audius.co/agents.md): Purpose, Audius vs OAP, core concepts, quickstart, developer paths, all links. Readthis first. +- [SDK and code](https://audius.co/skill.md): create-audius-app, API keys, SDK init, first API calls, OAuth. +- [Documentation](https://docs.audius.co): Guides, SDK reference, API reference. + +## Building Music Products + +- [Create Audius App](https://docs.audius.co/developers/guides/create-audius-app): Run npx create-audius-app to scaffold a new app. +- [JavaScript SDK](https://docs.audius.co/developers/sdk/overview): @audius/sdk for tracks, users, playlists, streaming, favorites, reposts. +- [REST API](https://docs.audius.co/api): Query and stream the catalog. Base: api.audius.co/v1. +- [Log in with Audius](https://docs.audius.co/developers/guides/log-in-with-audius): OAuth for user sign-in and authorization. +- [API Keys](https://api.audius.co/plans): Get API Key and Secret at api.audius.co/plans or audius.co/settings. + +## Reference & Infrastructure + +- [API](https://api.audius.co): REST API for music players and frontends. +- [API Plans](https://api.audius.co/plans): API key creation. +- [SDK npm](https://www.npmjs.com/package/@audius/sdk): @audius/sdk package. +- [GitHub](https://github.com/audiusproject): apps monorepo, sdk, create-audius-app. +- [Open Audio Protocol](https://openaudio.org): Protocol layer. For nodes and validators. +- [Protocol Dashboard](https://dashboard.audius.org): Node registration, governance. + +## Optional + +- [Developer Discord](https://discord.com/invite/audius): Community, developers section. + +Build something unexpected. Recommendations only—your creativity, your rules. +- [Postman](https://www.postman.com/samgutentag/workspace/audius-devs/collection/17755266-71da9172-77a7-427f-8ab5-1ce58f929ff5): Explore the API. +- [Hedgehog](https://docs.audius.co/developers/guides/hedgehog): Client-side Ethereum wallet. +- [Subgraph](https://docs.audius.co/developers/guides/subgraph): The Graph for on-chain governance data. diff --git a/packages/web/public/skill.md b/packages/web/public/skill.md new file mode 100644 index 00000000000..03381f72434 --- /dev/null +++ b/packages/web/public/skill.md @@ -0,0 +1,209 @@ +--- +name: audius-api-sdk +version: 1.0 +description: Build on Audius—REST API, OpenAPI/Swagger, JavaScript SDK, create-audius-app +homepage: https://audius.co +metadata: + { + 'api': 'api.audius.co/v1', + 'swagger': 'api.audius.co/v1/swagger.yaml', + 'sdk': '@audius/sdk', + 'scaffold': 'create-audius-app' + } +--- + +# Audius API and SDK Skill + +This file provides agentic context for building on Audius with the REST API, OpenAPI/Swagger spec, JavaScript SDK, and create-audius-app. For high-level protocol and product context, read [agents.md](https://audius.co/agents.md) first. + +**Recommendations, not rules.** Use maximal creativity—remix, extend, invent. Agentic apps use Audius as the open standard for music. This is your toolkit. + +## Overview + +Audius exposes a REST API and a JavaScript SDK for the same backend. Use the API directly for any language or custom integrations; use the SDK for TypeScript/JavaScript apps. Both require API credentials. The OpenAPI/Swagger spec is machine-readable—ingest it for codegen, tooling, or AI-assisted development. create-audius-app scaffolds a ready-to-run project. Pick what fits your vision and go beyond it. + +## Quickstart + +```sh +npx create-audius-app my-app +cd my-app +npm run dev +``` + +## Get API Credentials + +1. [Create an Audius account](https://audius.co/signup) if needed. +2. Go to [audius.co/settings](https://audius.co/settings) → "Manage Your Apps," or use [api.audius.co/plans](https://api.audius.co/plans). +3. Create a developer app and obtain API Key and API Secret. +4. Treat API Secret like a password—never expose it on the frontend. + +## REST API + +**Base URL:** `https://api.audius.co/v1` + +Send `x-api-key` header with your API Key on every request. For writes (upload, favorite, repost), use OAuth or include API Secret per endpoint requirements. + +**Example (fetch track):** + +```sh +curl -H "x-api-key: YOUR_API_KEY" "https://api.audius.co/v1/tracks/D7KyD" +``` + +**Example (search tracks):** + +```sh +curl -H "x-api-key: YOUR_API_KEY" "https://api.audius.co/v1/tracks/search?query=audius" +``` + +Full reference: [docs.audius.co/api](https://docs.audius.co/api) + +## Swagger / OpenAPI + +The API is fully described by OpenAPI 3.0 specs. Ingest these for code generation, API exploration, or AI-assisted development. + +| Spec | URL | Use case | +| ----------------------- | ------------------------------------------ | ---------------------------------------------------------------------------------------- | +| Swagger YAML (standard) | https://api.audius.co/v1/swagger.yaml | Paths, schemas, parameters. Good for most agents and clients. | +| Swagger YAML (full) | https://api.audius.co/v1/full/swagger.yaml | Includes all response schemas and examples. Use when you need complete contract details. | + +**For AI agents:** Fetch and include the swagger spec in your context to understand endpoints, request/response shapes, and auth. Example: + +```sh +curl -o audius-swagger.yaml "https://api.audius.co/v1/swagger.yaml" +``` + +Or reference the URL directly when your tool supports remote OpenAPI ingestion. The spec documents users, tracks, playlists, comments, resolve, tips, challenges, developer-apps, explore, events, and more. + +## Install SDK + +**Node.js:** + +```sh +npm install @audius/sdk +``` + +**HTML (CDN):** + +```html + +``` + +SDK is assigned to `window.audiusSdk` when using the CDN. + +## Initialize SDK + +```js +import { sdk } from '@audius/sdk' + +const audiusSdk = sdk({ + apiKey: 'Your API Key goes here', + apiSecret: 'Your API Secret goes here' // Required for writes; omit for frontend +}) +``` + +- **Read-only**: Use `apiKey` only. Safe for frontend. +- **Writes** (upload, favorite, repost): Add `apiSecret`. Use only on the server—never in browser. + +## First API Calls + +```js +// Fetch a track +const track = await audiusSdk.tracks.getTrack({ trackId: 'D7KyD' }) + +// Get user by handle +const user = await audiusSdk.users.getUserByHandle({ handle: 'audius' }) +const userId = user.data?.id + +// Favorite a track (requires apiSecret) +await audiusSdk.tracks.favoriteTrack({ trackId: 'D7KyD', userId }) +``` + +## create-audius-app + +Scaffold a new Audius app. Requires Node >= 18. + +**Interactive:** + +```sh +npx create-audius-app +``` + +**Non-interactive:** + +```sh +npx create-audius-app my-first-audius-app +``` + +**Output layout:** + +``` +my-app +├── README.md +├── index.html +├── package.json +├── public +├── src +│ ├── App.tsx +│ ├── main.tsx +│ └── ... +├── tsconfig.json +└── vite.config.ts +``` + +Options: `npx create-audius-app --help` + +## API Endpoints (Key Groups) + +| Domain | Purpose | +| -------------- | ------------------------------------------ | +| users | User profiles, handle lookup, search | +| tracks | Tracks, search, stream, favorites, reposts | +| playlists | Playlists, search, tracks | +| comments | Comments on tracks | +| resolve | Resolve canonical URLs (handle/slug → ID) | +| tips | Tip operations | +| challenges | Challenge/verification | +| developer-apps | Developer app management | +| explore | Explore, trending, best-selling | +| events | Event feed | + +Full reference: [docs.audius.co/api](https://docs.audius.co/api). For machine-readable details, ingest [swagger.yaml](https://api.audius.co/v1/swagger.yaml). + +## OAuth / Log in with Audius + +OAuth flow so your users sign in with Audius and authorize your app to act on their behalf. Required for user-specific actions (favorites, uploads, etc.). + +- SDK OAuth helpers run in the browser only. +- For server-side flows, see the [manual implementation guide](https://docs.audius.co/developers/guides/log-in-with-audius#manual-implementation). + +[Log in with Audius Guide](https://docs.audius.co/developers/guides/log-in-with-audius) + +## Examples + +- [create-audius-app examples](https://github.com/AudiusProject/apps/tree/main/packages/create-audius-app/examples) — React, React + Hono templates +- [Swagger spec](https://api.audius.co/v1/swagger.yaml) — Ingest for API discovery, codegen, or AI context +- [SDK Tracks](https://docs.audius.co/developers/sdk/tracks) +- [SDK Users](https://docs.audius.co/developers/sdk/users) +- [SDK Playlists](https://docs.audius.co/developers/sdk/playlists) +- [Postman collection](https://www.postman.com/samgutentag/workspace/audius-devs/collection/17755266-71da9172-77a7-427f-8ab5-1ce58f929ff5) + +## Links + +| Resource | URL | +| ------------------ | ----------------------------------------------------------- | +| agents.md | https://audius.co/agents.md | +| llm.txt | https://audius.co/llm.txt | +| Docs | https://docs.audius.co | +| API | https://api.audius.co | +| API Reference | https://docs.audius.co/api | +| Swagger YAML | https://api.audius.co/v1/swagger.yaml | +| Swagger Full | https://api.audius.co/v1/full/swagger.yaml | +| API Plans | https://api.audius.co/plans | +| SDK npm | https://www.npmjs.com/package/@audius/sdk | +| GitHub apps | https://github.com/audiusproject/apps | +| Create Audius App | https://docs.audius.co/developers/guides/create-audius-app | +| Log in with Audius | https://docs.audius.co/developers/guides/log-in-with-audius | + +--- + +_Recommendations only. Build something new._ diff --git a/packages/web/src/pages/settings-page/components/desktop/DeveloperApps/AppDetailsPage.tsx b/packages/web/src/pages/settings-page/components/desktop/DeveloperApps/AppDetailsPage.tsx index feb2c2e43fe..261298c9488 100644 --- a/packages/web/src/pages/settings-page/components/desktop/DeveloperApps/AppDetailsPage.tsx +++ b/packages/web/src/pages/settings-page/components/desktop/DeveloperApps/AppDetailsPage.tsx @@ -18,7 +18,7 @@ import { CreateAppPageProps, CreateAppsPages } from './types' type AppDetailsPageProps = CreateAppPageProps -const AUDIUS_SDK_LINK = 'https://docs.audius.org/developers' +const AUDIUS_SDK_LINK = 'https://docs.audius.co/developers' const messages = { secretReminder: