> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For full documentation content, see https://platform.bctrl.ai/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server.

# Wait For Invocation

POST https://api.bctrl.ai/v1/runtimes/{runtimeId}/invocations/{invocationId}/wait
Content-Type: application/json

Wait for a durable invocation on its live runtime to complete or time out waiting. Timeout values are in milliseconds.

Reference: https://platform.bctrl.ai/api/api-reference/runtimes/wait-for-invocation

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/runtimes/{runtimeId}/invocations/{invocationId}/wait:
    post:
      operationId: invocations-wait
      summary: Wait for an invocation
      description: >-
        Wait for a durable invocation on its live runtime to complete or time
        out waiting. Timeout values are in milliseconds.
      tags:
        - subpackage_runtimes
      parameters:
        - name: runtimeId
          in: path
          required: true
          schema:
            type: string
        - name: invocationId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvocationWait'
        '401':
          description: 'Authentication required: the API key is missing or invalid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: 'Forbidden: the API key cannot access this resource.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The requested resource was not found. Example code:
            `runtime.not_found`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            The request conflicts with the current resource state. Example code:
            `tool.name_conflict`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded. Retry after the delay indicated by Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            An upstream dependency was unavailable. Retry later. Example code:
            `runtime.host_unavailable`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvocationWaitRequest'
servers:
  - url: https://api.bctrl.ai
    description: Production
  - url: http://localhost:8787
    description: Local development gateway
components:
  schemas:
    InvocationWaitRequest:
      type: object
      properties:
        timeoutMs:
          type: integer
      title: InvocationWaitRequest
    InvocationWaitAction:
      type: string
      enum:
        - act
        - observe
        - extract
        - browserUse
        - stagehandAgent
        - solveCaptcha
      title: InvocationWaitAction
    InvocationWaitErrorCode:
      type: string
      enum:
        - invocation.failed
        - invocation.cancelled
        - invocation.timed_out
        - invocation.dispatch_preparation_failed
        - invocation.dispatch_unavailable
        - invocation.captcha_solve_failed
        - invocation.output_validation_failed
        - invocation.stagehand_failed
        - invocation.stagehand_incomplete
        - invocation.browser_use_failed
        - invocation.browser_use_interrupted
        - invocation.browser_use_incomplete
      description: >-
        Stable invocation error identifier for programmatic handling.

        `invocation.failed`: generic invocation failure.

        `invocation.cancelled`: invocation was cancelled before completion.

        `invocation.timed_out`: invocation exceeded its timeout.

        `invocation.dispatch_preparation_failed`: server could not prepare the
        invocation dispatch request.

        `invocation.dispatch_unavailable`: server could not dispatch the
        prepared invocation.

        `invocation.captcha_solve_failed`: CAPTCHA solving failed.

        `invocation.output_validation_failed`: produced output did not match the
        requested output schema.

        `invocation.stagehand_failed`: Stagehand returned a failure.

        `invocation.stagehand_incomplete`: Stagehand agent stopped before
        completing the task.

        `invocation.browser_use_failed`: Browser-use returned a failure.

        `invocation.browser_use_interrupted`: Browser-use was interrupted before
        completion.

        `invocation.browser_use_incomplete`: Browser-use stopped before
        completing the task.
      title: InvocationWaitErrorCode
    InvocationWaitError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/InvocationWaitErrorCode'
          description: >-
            Stable invocation error identifier for programmatic handling.

            `invocation.failed`: generic invocation failure.

            `invocation.cancelled`: invocation was cancelled before completion.

            `invocation.timed_out`: invocation exceeded its timeout.

            `invocation.dispatch_preparation_failed`: server could not prepare
            the invocation dispatch request.

            `invocation.dispatch_unavailable`: server could not dispatch the
            prepared invocation.

            `invocation.captcha_solve_failed`: CAPTCHA solving failed.

            `invocation.output_validation_failed`: produced output did not match
            the requested output schema.

            `invocation.stagehand_failed`: Stagehand returned a failure.

            `invocation.stagehand_incomplete`: Stagehand agent stopped before
            completing the task.

            `invocation.browser_use_failed`: Browser-use returned a failure.

            `invocation.browser_use_interrupted`: Browser-use was interrupted
            before completion.

            `invocation.browser_use_incomplete`: Browser-use stopped before
            completing the task.
        details:
          type: object
          additionalProperties:
            description: Any type
          description: Action-specific structured context. Use `code` for branching.
        message:
          type: string
          description: Human-readable summary of why the invocation failed.
      required:
        - code
        - message
      title: InvocationWaitError
    JsonValue:
      description: Any type
      title: JsonValue
    InvocationWaitStatus:
      type: string
      enum:
        - queued
        - dispatching
        - running
        - cancelling
        - succeeded
        - failed
        - cancelled
        - timed_out
      title: InvocationWaitStatus
    InvocationWaitWaitStatus:
      type: string
      enum:
        - completed
        - timeout
      title: InvocationWaitWaitStatus
    InvocationWait:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/InvocationWaitAction'
        createdAt:
          type: string
        durationMs:
          type:
            - integer
            - 'null'
        error:
          oneOf:
            - $ref: '#/components/schemas/InvocationWaitError'
            - type: 'null'
        finishedAt:
          type:
            - string
            - 'null'
        id:
          type: string
          format: uuid
        output:
          $ref: '#/components/schemas/JsonValue'
        retryAfterMs:
          type: integer
        runId:
          type: string
          format: uuid
        runtimeId:
          type: string
          format: uuid
        startedAt:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/InvocationWaitStatus'
        waitStatus:
          $ref: '#/components/schemas/InvocationWaitWaitStatus'
      required:
        - action
        - createdAt
        - id
        - runId
        - runtimeId
        - status
        - waitStatus
      title: InvocationWait
    ErrorResponseReasonClass:
      type: string
      enum:
        - invalid_input
        - unauthorized
        - capability_denied
        - capability_limit_exceeded
        - rate_limited
        - not_found
        - conflict
        - upstream
        - server
      description: Stable public error category for programmatic branching.
      title: ErrorResponseReasonClass
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: >-
            Stable, dot-namespaced error code, e.g. "runtime.not_found" or
            "request.invalid".
        details:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            Resource-specific structured context. Use `code` and `reasonClass`
            for branching.
        error:
          type: string
        hint:
          type: string
          description: Optional next action for recoverable errors, e.g. "retry after 2s".
        reasonClass:
          $ref: '#/components/schemas/ErrorResponseReasonClass'
          description: Stable public error category for programmatic branching.
        requestId:
          type: string
      required:
        - code
        - error
      title: ErrorResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "action": "act",
  "createdAt": "2024-06-01T12:00:00Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "runId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "runtimeId": "1c9e6679-7425-40de-944b-e07fc1f90ae7",
  "status": "failed",
  "waitStatus": "completed",
  "durationMs": 3500,
  "error": {
    "code": "invocation.failed",
    "message": "The invocation failed due to an unexpected error during execution.",
    "details": {}
  },
  "finishedAt": "2024-06-01T12:00:03Z",
  "output": null,
  "retryAfterMs": 5000,
  "startedAt": "2024-06-01T11:59:56Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/runtimes/runtimeId/invocations/invocationId/wait")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```