> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Get local runner

GET http://localhost:5173/api/v1/private/local-runners/{runnerId}

Get a single local runner with its registered agents

Reference: https://www.comet.com/docs/opik/reference/rest-api/runners/get-runner

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `runnerId` (string, required)

## Response

### 200

Runner details

- `id` (string, optional)
- `name` (string, optional)
- `project_id` (string, optional)
- `status` (enum, optional)
  - Allowed values: `pairing`, `connected`, `disconnected`
- `connected_at` (datetime, optional)
- `agents` (list of Agent, optional)
- `capabilities` (list of string, optional)
- `checklist` (JsonNode, optional)
- `type` (enum, optional)
  - Allowed values: `connect`, `endpoint`

## Errors

### 404 Not Found Error

Not found

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Types

### Agent

- `name` (string, optional)
- `description` (string, optional)
- `language` (string, optional)
- `executable` (string, optional)
- `source_file` (string, optional)
- `params` (list of Param, optional)
- `timeout` (integer, optional)

### JsonNode

### Param

- `name` (string, required)
- `type` (string, required)
- `presence` (enum, optional)
  - Allowed values: `required`, `optional`

## Examples

**Response**

```json
{
  "id": "string",
  "name": "string",
  "project_id": "string",
  "status": "pairing",
  "connected_at": "2024-01-15T09:30:00Z",
  "agents": [
    {
      "name": "string",
      "description": "string",
      "language": "string",
      "executable": "string",
      "source_file": "string",
      "params": [
        {
          "name": "string",
          "type": "string",
          "presence": "required"
        }
      ],
      "timeout": 1
    }
  ],
  "capabilities": [
    "string"
  ],
  "checklist": {},
  "type": "connect"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/local-runners/runnerId"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/local-runners/runnerId';
const options = {method: 'GET'};

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 := "http://localhost:5173/api/v1/private/local-runners/runnerId"

	req, _ := http.NewRequest("GET", url, nil)

	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("http://localhost:5173/api/v1/private/local-runners/runnerId")

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

request = Net::HTTP::Get.new(url)

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.get("http://localhost:5173/api/v1/private/local-runners/runnerId")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/local-runners/runnerId');

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

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/local-runners/runnerId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/local-runners/runnerId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```