List provider resources

The resources providers offer (e.g. a machine, an inbox, a phone number) with display copy, prices (recurring rent and metered usage rates) and the endpoints that operate on them. Filter by category and/or provider.

GET /public/v1/resources

List provider resources

cURL

curl --request GET \
  --url https://api.monid.ai/public/v1/resources

200

{
  "items": [
    {
      "provider": "smolmachine",
      "providerDisplayName": "Smol Machines",
      "resource": "SmolmachineMachine",
      "resourceType": "machine",
      "displayName": "Virtual machine",
      "displayDescription": "<string>",
      "summary": "<string>",
      "pricing": {
        "rent": {
          "type": "BY_PERIOD",
          "amount": {
            "value": 123,
            "currency": "USD"
          },
          "period": {
            "unit": "MINUTE",
            "count": 123
          }
        },
        "rateCard": [
          {
            "label": "cpu",
            "ratePerUnit": 0.05,
            "per": "vCPU·hour"
          }
        ],
        "firstPeriodChargedAtCreation": true
      },
      "endpoints": [
        {
          "endpoint": "/machines",
          "displayName": "Create machine",
          "price": {
            "type": "<string>",
            "amount": {
              "value": 123,
              "currency": "USD"
            },
            "flatFee": {
              "value": 123,
              "currency": "USD"
            },
            "period": {
              "unit": "MINUTE",
              "count": 123
            },
            "per": {
              "unit": "MINUTE",
              "count": 123
            },
            "unit": "token",
            "default": {
              "type": "PER_CALL",
              "amount": {
                "value": 123,
                "currency": "USD"
              }
            },
            "selectors": [
              {
                "label": "<string>",
                "key": "<string>",
                "in": "body",
                "offset": 1
              }
            ],
            "variants": [
              {
                "when": {},
                "price": {
                  "type": "PER_CALL",
                  "amount": {
                    "value": 123,
                    "currency": "USD"
                  }
                },
                "label": "<string>"
              }
            ],
            "tiers": [
              {
                "label": "<string>",
                "price": {
                  "type": "PER_CALL",
                  "amount": {
                    "value": 123,
                    "currency": "USD"
                  }
                },
                "when": {},
                "selector": {
                  "label": "<string>",
                  "key": "<string>",
                  "in": "body",
                  "offset": 1
                }
              }
            ]
          },
          "effects": [
            "create"
          ]
        }
      ],
      "categories": [
        "<string>"
      ],
      "providerUrl": "<string>",
      "providerDocsUrl": "<string>"
    }
  ]
}

Query Parameters

category · string

Category node id to filter by (top group, leaf category, or provider node id from GET /public/v1/categories).

Maximum string length: 60

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Example:

"virtual-machines"

provider · string

Exact provider slug.

Required string length: 1 - 200

Example:

"smolmachine"

Response

200

application/json

Matching resources

items · object[] · required

Show child attributes