> 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. # Get Invocation GET https://api.bctrl.ai/v1/invocations/{id} Get one durable invocation and its current state. Use this to track agent work submitted to a runtime. Reference: https://platform.bctrl.ai/api/api-reference/invocations/get ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: bctrl API version: 1.0.0 paths: /v1/invocations/{id}: get: operationId: get summary: Get a durable invocation description: >- Get one durable invocation and its current state. Use this to track agent work submitted to a runtime. tags: - subpackage_invocations parameters: - name: id in: path required: true schema: type: string - name: Authorization in: header description: Use Bearer . required: true schema: type: string responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/invocations_get_Response_200' servers: - url: https://api.bctrl.ai - url: http://localhost:8787 components: schemas: V1InvocationsIdGetResponsesContentApplicationJsonSchemaError: type: object properties: code: type: string details: type: object additionalProperties: description: Any type message: type: string required: - message title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaError V1InvocationsIdGetResponsesContentApplicationJsonSchemaExecutionMode: type: string enum: - inline - durable title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaExecutionMode V1InvocationsIdGetResponsesContentApplicationJsonSchemaProgress: type: object properties: currentCall: type: string lastEventType: type: string message: type: string step: type: integer totalSteps: type: integer title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaProgress V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequestStepsItemsOptions: type: object properties: dryRun: type: boolean timeoutMs: type: integer title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequestStepsItemsOptions V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequestStepsItems: type: object properties: args: type: array items: description: Any type bind: type: string call: type: string options: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequestStepsItemsOptions ref: type: string required: - call title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequestStepsItems V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequest: type: object properties: idempotencyKey: type: string mode: type: string enum: - fail-fast runtimeId: type: string format: uuid steps: type: array items: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequestStepsItems required: - runtimeId - steps title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequest V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0BindingType: type: string enum: - page - context - handle - subscription title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0BindingType V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Binding: type: object properties: alias: type: string id: type: string type: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0BindingType required: - alias - id - type title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Binding V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Resolved: type: object properties: call: type: string contextId: type: - string - 'null' handleId: type: - string - 'null' method: type: string pageId: type: - string - 'null' ref: type: - string - 'null' runtimeId: type: string target: type: string required: - call - contextId - handleId - method - pageId - ref - runtimeId - target title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Resolved V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems0: type: object properties: binding: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Binding call: type: string index: type: integer ok: type: boolean enum: - true resolved: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf0Resolved result: description: Any type required: - call - index - ok - resolved - result title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems0 V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorCode: type: string enum: - UNKNOWN_CALL - UNKNOWN_REF - INVALID_ARGS - CAPABILITY_NOT_AVAILABLE - TIMEOUT - RUNTIME_NOT_FOUND - DRIVER_NOT_CONNECTED - SUBSCRIPTION_CURSOR_CONFLICT - SUBSCRIPTION_GONE title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorCode V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticCategory: type: string enum: - arg-shape - semantic - runtime title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticCategory V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticFixesItems: type: object properties: command: type: string example: type: string title: type: string required: - title title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticFixesItems V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnostic: type: object properties: call: type: string category: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticCategory closest: type: array items: type: string code: type: string docsUrl: type: string format: uri driver: type: string expected: type: string fixes: type: array items: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnosticFixesItems id: type: string received: type: string required: - id title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnostic V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1Error: type: object properties: code: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorCode diagnostic: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1ErrorDiagnostic hint: type: string message: type: string required: - code - message title: >- V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1Error V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems1: type: object properties: call: type: string error: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItemsOneOf1Error index: type: integer ok: type: boolean enum: - false required: - call - error - index - ok title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems1 V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems: oneOf: - $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems0 - $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems1 title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems V1InvocationsIdGetResponsesContentApplicationJsonSchemaResult: type: object properties: mode: type: string enum: - fail-fast ok: type: boolean runtimeId: type: string format: uuid steps: type: array items: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResultStepsItems required: - mode - ok - runtimeId - steps title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaResult V1InvocationsIdGetResponsesContentApplicationJsonSchemaRuntimeKind: type: string enum: - browser - desktop - spreadsheet title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaRuntimeKind V1InvocationsIdGetResponsesContentApplicationJsonSchemaStatus: type: string enum: - queued - dispatching - running - cancelling - succeeded - failed - cancelled - timed_out title: V1InvocationsIdGetResponsesContentApplicationJsonSchemaStatus invocations_get_Response_200: type: object properties: artifactCount: type: integer cancelRequestedAt: type: - string - 'null' connector: type: - string - 'null' correlationId: type: - string - 'null' createdAt: type: string durationMs: type: - integer - 'null' entryCall: type: string error: oneOf: - $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaError - type: 'null' executionMode: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaExecutionMode finishedAt: type: - string - 'null' id: type: string format: uuid lastHeartbeatAt: type: - string - 'null' metadata: type: - object - 'null' additionalProperties: description: Any type progress: oneOf: - $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaProgress - type: 'null' request: oneOf: - $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaRequest - type: 'null' result: oneOf: - $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaResult - type: 'null' runId: type: string format: uuid runtimeId: type: string format: uuid runtimeKind: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaRuntimeKind sequenceNo: type: integer spaceId: type: string format: uuid startedAt: type: - string - 'null' status: $ref: >- #/components/schemas/V1InvocationsIdGetResponsesContentApplicationJsonSchemaStatus stepCount: type: integer required: - artifactCount - createdAt - entryCall - executionMode - id - runId - runtimeId - runtimeKind - sequenceNo - spaceId - status - stepCount title: invocations_get_Response_200 securitySchemes: bearerAuth: type: http scheme: bearer description: Use Bearer . ``` ## SDK Code Examples ```python import requests url = "https://api.bctrl.ai/v1/invocations/id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.bctrl.ai/v1/invocations/id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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" "net/http" "io" ) func main() { url := "https://api.bctrl.ai/v1/invocations/id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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/invocations/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.bctrl.ai/v1/invocations/id") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.bctrl.ai/v1/invocations/id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.bctrl.ai/v1/invocations/id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/invocations/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```