Submit bridge command | Opik Documentation

POST/v1/private/local-runners/{runnerId}/bridge/commandsSubmit bridge command

Submit a bridge command for execution by the local daemon

Parameters

runnerIdstring · uuidpathrequired

Request body

application/json

objectBridgeCommandSubmitRequest

argsobjectrequired

timeout_secondsinteger · int32

typestringrequired

one of "ReadFile", "WriteFile", "EditFile", "ListFiles", "SearchFiles", "Exec"

Example request

{
  "args": {},
  "timeout_seconds": 0,
  "type": "EditFile"
}

Responses

Headers

Location

URI of the command

objectBridgeCommandSubmitResponse

command_idstring · uuid

Example response

{
  "command_id": "00000000-0000-0000-0000-000000000000"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

runnerIdrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands' \
  -H 'Content-Type: application/json' \
  -d '{"args":{},"timeout_seconds":0,"type":"EditFile"}'

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"args":{},"timeout_seconds":0,"type":"EditFile"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"args\":{},\"timeout_seconds\":0,\"type\":\"EditFile\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands",
    headers={"Content-Type": "application/json"},
    data='{"args":{},"timeout_seconds":0,"type":"EditFile"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"args":{},"timeout_seconds":0,"type":"EditFile"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"args\":{},\"timeout_seconds\":0,\"type\":\"EditFile\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"args\":{},\"timeout_seconds\":0,\"type\":\"EditFile\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"args\":{},\"timeout_seconds\":0,\"type\":\"EditFile\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/bridge/commands");
request.Content = new StringContent("{\"args\":{},\"timeout_seconds\":0,\"type\":\"EditFile\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "command_id": "00000000-0000-0000-0000-000000000000"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}