AITools
getRegistryLast updated on
Last updated on
Fetch registry.json from a URL, returns available artifacts
Fetches registry.json from a registry URL and returns the list of available artifacts.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
registryUrl | string | Yes | Registry base URL (e.g. https://public.open-form.dev) |
Response
| Field | Type | Description |
|---|---|---|
name | string | The registry URL |
artifactsPath | string | Base path for artifact files within the registry |
items | array | List of artifacts, each with name and optional path |
error | string | Error message if the fetch failed |
Direct usage
import { executeGetRegistry } from "@open-form/ai-tools"
const result = await executeGetRegistry({
registryUrl: "https://public.open-form.dev",
})
// {
// name: "https://public.open-form.dev",
// items: [
// { name: "pet-addendum", path: "pet-addendum/pet-addendum.json" },
// { name: "w-9", path: "w-9/w-9.json" },
// ]
// }Example response
{
"name": "https://public.open-form.dev",
"items": [
{
"name": "pet-addendum",
"path": "pet-addendum/pet-addendum.json"
},
{
"name": "w-9",
"path": "w-9/w-9.json"
}
]
}