docs: LLM-first quickstart + GET /v1/models and chat-completions reference (#3)#4
Closed
longnhp12 wants to merge 2 commits into
Closed
docs: LLM-first quickstart + GET /v1/models and chat-completions reference (#3)#4longnhp12 wants to merge 2 commits into
longnhp12 wants to merge 2 commits into
Conversation
Collaborator
Author
|
Superseded — reopening as a regular same-repo PR (branch |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
Workstream 3/4 (Docs) of the Deva LLM API v1 epic (
Bitplanet-L1/cross-eco-internal-docs#248). Per #3: docs led with agent identity/registration and had no LLM on-ramp; the API reference listedPOST /v1/chat/completionsonly as a table row and didn't documentGET /v1/modelsat all.Part of #3 — covers the three active checkboxes (LLM-first quickstart, canonical path +
/v1/modelsreference, SDK separation). The deferreddeva.me/docshosting checkbox stays open, so this PR intentionally does not close the issue.What
docs/quickstart.md— restructured to lead with "Call the Deva LLM API" (OpenRouter-style 3 steps): get a key viaPOST /agents/register, make a chat completion (cURL + official OpenAI Python/JS SDKs withbase_url = https://api.deva.me/v1), and read costs (usage.cost,usage.deva.karma_cost/karma_balance,X-Deva-Karma-*headers, streaming final-chunk usage). The agent-platform quickstart is preserved below under its own heading.docs/api-reference.md— new fullGET /v1/modelssubsection (query params, list envelope, all model fields incl.description,input/output_modalities, USD-per-token + karma pricing strings, capabilities, cache headers, detail route) and an expandedPOST /v1/chat/completionssubsection (canonical path per D1, request shape, streaming usage chunk, karma billing surfaces,402 insufficient_quota). AI-resources table updated.@deva-ai/sdk(Deva-me-AI/deva-agent-sdk, native LLM/agent-resources SDK — on GitHub, npm publish pending) vs@bitplanet/deva-sdk("Login with Deva" auth SDK). Since the native SDK is unpublished, the quickstart deliberately uses the OpenAI SDKs and has nonpm install @deva-ai/sdkinstructions.README.md— "Call any LLM" added as quickstart step 2 + SDKs section;docs/pricing.mdpoints atGET /v1/models/ deva.me/models as the live per-model pricing source.Verification
GET /v1/modelsexample JSON copied from the live production endpoint (34 models, post-Bitplanet-L1/content-server#1959contract with descriptions/modalities/real capabilities).usage/402shapes validated against content-server source (app/schemas/ai_completions.py,app/apis/ai_completions.py)./v1/ai/chat/completionsreferences; no install instructions for the unpublished SDK.🤖 Generated with Claude Code