Get a resource

Get a single workspace-owned resource. External detail is a separate on-demand live fetch — see GET /v1/resources//external/.

GET /v1/resources/{resourceId}

Get a resource

cURL

curl --request GET \
  --url https://api.monid.ai/v1/resources/{resourceId} \
  --header 'Authorization: Bearer <token>'

200

{
  "resourceId": "<string>",
  "provider": "<string>",
  "resourceSlug": "<string>",
  "resourceType": "<string>",
  "externalId": "<string>",
  "identifier": "<string>",
  "releasable": true,
  "state": "READY",
  "provisionedBy": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "providerName": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "summary": "<string>",
  "releasedBy": "<string>",
  "renewal": {
    "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
          }
        }
      ],
      "notes": [
        "<string>"
      ]
    },
    "renewLead": {
      "unit": "<string>",
      "count": 123
    },
    "startedAt": "2023-11-07T05:31:56Z",
    "currentPeriodStart": "2023-11-07T05:31:56Z",
    "currentPeriodEnd": "2023-11-07T05:31:56Z",
    "renewAttemptAt": "2023-11-07T05:31:56Z",
    "cycle": 123,
    "lastAttempt": {
      "at": "2023-11-07T05:31:56Z",
      "outcome": "SUCCEEDED",
      "reason": "<string>"
    },
    "cancelledAt": "2023-11-07T05:31:56Z"
  },
  "releasedAt": "2023-11-07T05:31:56Z",
  "releaseReasonCode": "<string>",
  "releaseReason": "<string>",
  "phoneNumber": "<string>",
  "country": "<string>",
  "numberType": "<string>",
  "name": "<string>",
  "totalBytes": 123,
  "objectCount": 123,
  "lastMutationAt": "2023-11-07T05:31:56Z",
  "expiresAt": "<string>",
  "ttl": 123,
  "activityTtl": 123,
  "profileId": "<string>",
  "profileSaveChanges": true,
  "liveViewUrl": "<string>",
  "interactiveLiveViewUrl": "<string>",
  "cdpUrl": "<string>",
  "baseUrl": "<string>",
  "targetUrl": "<string>",
  "timeoutSeconds": 123,
  "proxyCountryCode": "<string>",
  "externalResources": [
    {
      "kind": "<string>",
      "displayName": "<string>",
      "label": "<string>"
    }
  ],
  "syncedAt": "2023-11-07T05:31:56Z",
  "usageBilling": {
    "rateCard": [
      {
        "label": "<string>",
        "ratePerUnit": 123,
        "per": "<string>"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Monid API key (Authorization: Bearer mk_...) or Clerk-issued JWT. Each operation lists the ONE scope an API key needs. {resource}:* grants every action on that resource; * grants everything; Clerk sessions hold *. Operations with an empty list need no scope. Scope catalog: GET /v1/api-keys/scopes.

Headers

X-Monid-Agent-Model · string

Model driving the calling agent. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256

X-Monid-Agent-Harness · string

Agent harness or client making the call (e.g. a coding agent, an agent framework). Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256

X-Monid-Agent-Session-Id · string

Caller-side session identifier, so the calls of one agent session (discover → inspect → run → polling) can be correlated. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256

Path Parameters

resourceId · string · required

Resource identifier (ULID).

Response

200

application/json

The resource

resourceId · string · required

Resource identifier (ULID).

provider · string · required

resourceSlug · string · required

resourceType · string · required

externalId · string · required

identifier · string · required

releasable · boolean · required

state · enum<string> · required

Lifecycle state.

Available options: READY, PROVISIONING, ACTIVE, EXPIRING, SUSPENDED, RELEASED, PROVISION_FAILED

provisionedBy · string · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

providerName · string

displayName · string

Resource display name (e.g. "Machine").

description · string

Short one-line description.

summary · string

Detailed description.

releasedBy · string

renewal · object

Show child attributes

releasedAt · string<date-time>

releaseReasonCode · string

releaseReason · string

phoneNumber · string

country · string

numberType · string

name · string

totalBytes · integer

objectCount · integer

lastMutationAt · string<date-time>

expiresAt · string

ttl · number

activityTtl · number

profileId · string

profileSaveChanges · boolean

liveViewUrl · string

interactiveLiveViewUrl · string

cdpUrl · string

baseUrl · string

targetUrl · string

timeoutSeconds · integer

proxyCountryCode · string

externalResources · object[]

Show child attributes

syncedAt · string<date-time>

usageBilling · object

Metered usage pricing (absent for rent-only resources).

Show child attributes