Dynamiq
End User Requirements

Check requirements status for an end user

Returns whether all end-user requirements of the app are satisfied for the given user, together with the list of unsatisfied requirements. A connection requirement counts as satisfied when the user has an active connection for it; an action connector account requirement counts as satisfied when the user has linked an account for it. The app is identified by the hostname. Private apps require an Access Key; public apps can be called without credentials.

GET
/v1/requirements/status

Authorization

accessKey
AuthorizationBearer <token>

Organization or project Access Key created in the Dynamiq console. Used for deployed-app (Runs API), AI Gateway, traces collector, and management API requests. Send as Authorization: Bearer <access-key>.

In: header

Query Parameters

user_id*string

Caller-supplied end-user identifier.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/requirements/status?user_id=string"
{
  "status": "incomplete",
  "unsatisfied": [
    {
      "id": "9b8e2f4d-1c3a-4d5e-8f60-718293a4b5c6",
      "type": "pipedream_account",
      "form": {
        "title": "Connect your Gmail account",
        "description": "Used to send triage replies on your behalf."
      },
      "spec": {
        "type": "pipedream_account",
        "data": {
          "app_slug": "gmail"
        }
      },
      "workflow_id": "2b3c4d5e-6f70-4182-93a4-b5c6d7e8f901",
      "name": "gmail_account"
    }
  ]
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

List run artifacts

Lists files produced by a run, with short-lived download URLs.

Create a connect token

Creates a short-lived **connect token** for an end user of the app. The token is a bearer JWT scoped to this app and this user, valid for **24 hours**, and is the credential accepted by the `/v1/connect/*` requirement-fulfillment endpoints on the management API — it is distinct from Access Keys and Personal Access Tokens. The response also includes the URL of the hosted connect page, pre-filled with the token, where the end user can fulfill the requirements in a browser. The app is identified by the hostname. Private apps require an Access Key; public apps can be called without credentials.