Devnpm package details · npm Registry

npm.package

Retrieve a public npm package, including scoped names. Omit version for the full package document and version history, or specify latest, a dist-tag or an exact version. Returns a compact summary; details returns the complete retrieved document, including dependencies, license, repository, maintainers, tarball URLs and README when available.

POST/v1/capabilities/npm.package/execute
Charge returned per callStable
operationId
executeNpmPackage
Source
npm Registry
Typical credits
0 (free source)
Search deadline
15 s server-side
Paging
single result
Availability
ConfiguredChecked 2026-11-03 16:34 UTC
Cost basis
Free public npm API; cached details cost 0 credits. Availability is reported per deployment by GET /v1/catalog (available). The timestamped snapshot describes configuration, not provider uptime or your account's enabled choices. Check the catalog with your own key before a call. Credits are explained under credits and limits.

Request body

Body of POST /v1/capabilities/npm.package/execute, JSON, validated against the NpmPackageRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.

Request fields of npm.package
FieldDescription
packagestringREQUIREDPublic npm package name, including scoped names such as @babel/core.min length 1 · max length 214 · pattern ^(?:@[a-zA-Z0-9_~][a-zA-Z0-9._~-]*/)?[a-zA-Z0-9_~][a-zA-Z0-9._~-]*$
versionstringlatest, a dist-tag, or an exact version such as 3.23.8. Omit for full metadata and version history.min length 1 · max length 256 · pattern ^[a-zA-Z0-9][a-zA-Z0-9._+~-]*$
  • Unknown keys are rejected with 400 invalid_request.

Examples

Full version history
curl
curl -s -X POST https://api.powerups-ai.store/v1/capabilities/npm.package/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"package":"zod"}'
Latest version
curl
curl -s -X POST https://api.powerups-ai.store/v1/capabilities/npm.package/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"package":"zod","version":"latest"}'
Specific version
curl
curl -s -X POST https://api.powerups-ai.store/v1/capabilities/npm.package/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"package":"zod","version":"3.23.8"}'
Scoped package
curl
curl -s -X POST https://api.powerups-ai.store/v1/capabilities/npm.package/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"package":"@babel/core","version":"latest"}'

Record fields

Each item in results[] carries record_id and title (contract, always present) and usually url and snippet. The other keys below are the documented tier: produced deterministically by this capability, omitted when the source has no value, checked against recorded source fixtures in our test suite, and published as the NpmPackageRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. Anything else comes from the provider and may change; see stability tiers.

Record keys of npm.package
KeyNote
record_idstringALWAYSUse it with record actions on POST /v1/follow-up.
titlestringALWAYSContract key.
urlstringContract key; usually present.
snippetstringContract key; usually present.
packagestringALWAYSOn every record.
versionstringWhen the source has it.
licensestring | objectWhen the source has it.
repositorystring | objectWhen the source has it.
maintainersobject[]When the source has it.
dependenciesobjectWhen the source has it.
distobjectWhen the source has it.
dist_tagsobjectWhen the source has it.
version_countintegerWhen the source has it.

Caveats

  • Omit version for all version manifests and README when available; latest or an exact version returns one manifest.
  • Metadata documents larger than 8 MiB return provider_error. Request a specific version for large packages.

Follow-ups

Paging: Single result; more is refused with 400 invalid_request.

detailsComplete cached package or version metadata from this lookup.

Not offered: update.

Detail behaviour: Stored at search time; details is free and never calls the provider. details returns the complete cached package or version document for free.

record action
curl -s -X POST https://api.powerups-ai.store/v1/follow-up \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"record_id":"rec_…","action":"details"}'

Record detail objects of this capability are provider-shaped: documented by observation, not by schema. Full follow-up semantics: follow-up.

Typed client

With types generated from the public document (see types, client and samples) the call is path-keyed and the body is checked at compile time:

TypeScript (openapi-fetch)
const { data, error } = await client.POST("/v1/capabilities/npm.package/execute", {
  body: {
    "package": "zod"
  },
});
if (error) throw new Error(`${error.error.code}: ${error.error.message}`);
for (const record of data.results) console.log(record.record_id, record.title);
Recorded responseproduction · 27 Sep
Request
POST /v1/capabilities/npm.package/execute

{
  "package": "zod"
}