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.
Authorization
accessKey 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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/connect/tokens" \ -H "Content-Type: application/json" \ -d '{ "user_id": "customer-7421" }'{
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiY3VzdG9tZXItNzQyMSJ9.sig",
"url": "https://app.getdynamiq.ai/connect?token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"expires_at": "2026-06-11T09:15:21Z"
}{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}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.
List requirements
Lists the end-user requirements of the app the connect token is scoped to — the connection and action connector account requirements referenced by the app's deployed workflow version. Served on the management API; authenticate with a connect token.