Resources

Get a resource

Changed on

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

get/v1/resources/{resourceId}

Request

  • Base URL: https://api.monid.ai
  • URL: https://api.monid.ai/v1/resources/{resourceId}
  • Auth: HTTP bearer

Path parameters

resourceIdstring required

Resource identifier (ULID).

Headers

X-Monid-Agent-Modelstring

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

X-Monid-Agent-Harnessstring

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).

X-Monid-Agent-Session-Idstring

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).

Response

The resource

resourceIdstring required

Resource identifier (ULID).

providerstring required
providerNamestring
resourceSlugstring required
resourceTypestring required
displayNamestring

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

descriptionstring

Short one-line description.

summarystring

Detailed description.

externalIdstring required
identifierstring required
releasableboolean required
state'READY' | 'PROVISIONING' | 'ACTIVE' | 'EXPIRING' | 'SUSPENDED' | 'RELEASED' | 'PROVISION_FAILED' required

Lifecycle state.

provisionedBystring required
releasedBystring
createdAtstring date-time required
updatedAtstring date-time required
releasedAtstring date-time
releaseReasonCodestring
releaseReasonstring
phoneNumberstring
countrystring
numberTypestring
namestring
totalBytesinteger
objectCountinteger
lastMutationAtstring date-time
cdpUrlstring
baseUrlstring
targetUrlstring
timeoutSecondsinteger
proxyCountryCodestring
syncedAtstring date-time

Changes

  • 47b1a281e325Revision changes
    • warning

      added the new byte enum value to the //// response property for the response status

    • warning

      added the new byte enum value to the ////// response property for the response status

    • warning

      added the new byte enum value to the // response property for the response status

    • warning

      added the new byte enum value to the ////// response property for the response status

  • 631143e91790Revision changes
    • info

      added the new optional header request parameter X-Monid-Agent-Harness

    • info

      added the new optional header request parameter X-Monid-Agent-Model

    • info

      added the new optional header request parameter X-Monid-Agent-Session-Id

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status