added POST /api/v1/waitpoints/tokens docs

Author: isshaddad

docs/docs.json

@@ -302,6 +302,12 @@
               "management/deployments/promote"
             ]
           },
+          {
+            "group": "Waitpoints API",
+            "pages": [
+              "management/waitpoints/create"
+            ]
+          },
           {
             "group": "Query API",
             "pages": ["management/query/execute"]

docs/management/waitpoints/create.mdx

@@ -0,0 +1,4 @@
+---
+title: "Create a waitpoint token"
+openapi: "v3-openapi POST /api/v1/waitpoints/tokens"
+---

docs/v3-openapi.yaml

@@ -2656,6 +2656,50 @@ paths:
               name: "my-task-id",
             });
 
+  "/api/v1/waitpoints/tokens":
+    post:
+      operationId: create_waitpoint_token_v1
+      summary: Create a waitpoint token
+      description: >-
+        Creates a new waitpoint token that can be used to pause a run until an external event completes it.
+        The token includes a `url` which can be called via HTTP POST to complete the waitpoint.
+        Use the token ID with `wait.forToken()` inside a task to pause execution until the token is completed.
+      requestBody:
+        required: false
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/CreateWaitpointTokenRequest"
+      responses:
+        "200":
+          description: Waitpoint token created successfully
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/CreateWaitpointTokenResponse"
+        "401":
+          description: Unauthorized
+        "422":
+          description: Unprocessable Entity
+        "500":
+          description: Internal Server Error
+      tags:
+        - waitpoints
+      security:
+        - secretKey: []
+      x-codeSamples:
+        - lang: typescript
+          source: |-
+            import { wait } from "@trigger.dev/sdk";
+
+            const token = await wait.createToken({
+              timeout: "1h",
+              tags: ["user:1234567"],
+            });
+
+            console.log(token.id);  // e.g. "waitpoint_abc123"
+            console.log(token.url); // HTTP callback URL to complete externally
+
 components:
   parameters:
     taskIdentifier:
@@ -4216,3 +4260,60 @@ components:
             results:
               type: string
               description: CSV-formatted results
+    CreateWaitpointTokenRequest:
+      type: object
+      properties:
+        idempotencyKey:
+          type: string
+          description: >-
+            An optional idempotency key. If you pass the same key twice before it expires,
+            you will receive the original token back. The returned token may already be completed,
+            in which case `wait.forToken()` will continue immediately.
+          example: approval-user-1234567
+        idempotencyKeyTTL:
+          type: string
+          description: >-
+            How long the idempotency key is valid, after which passing the same key
+            creates a new waitpoint. Accepts durations like "30s", "1m", "2h", "3d".
+          example: 1h
+        timeout:
+          type: string
+          description: >-
+            How long to wait before the token times out. When a run is waiting for a timed-out
+            token, `wait.forToken()` returns with `ok: false`. Accepts an ISO 8601 date string
+            or duration shorthand like "30s", "1m", "2h", "3d", "4w".
+          example: 1h
+        tags:
+          oneOf:
+            - type: string
+            - type: array
+              items:
+                type: string
+          description: >-
+            Tags to attach to the waitpoint. You can set up to 10 tags, each under 128 characters.
+            We recommend namespacing tags with a prefix like `user:1234567` or `org_9876543`.
+          example:
+            - "user:1234567"
+            - "org:9876543"
+    CreateWaitpointTokenResponse:
+      type: object
+      required:
+        - id
+        - isCached
+        - url
+      properties:
+        id:
+          type: string
+          description: The unique ID of the waitpoint token.
+          example: waitpoint_abc123
+        isCached:
+          type: boolean
+          description: >-
+            `true` if an existing token was returned because the same `idempotencyKey`
+            was used within its TTL window.
+        url:
+          type: string
+          description: >-
+            An HTTP callback URL. A POST request to this URL (with an optional JSON body)
+            will complete the waitpoint without needing an API key.
+          example: https://api.trigger.dev/api/v1/waitpoints/tokens/waitpoint_abc123/callback/abc123hash