List routers

GET

/api/routers

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.langparse.dev/api/routers");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "X-Api-Key: <X-Api-Key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.langparse.dev/api/routers"),
    Headers =
    {
        { "X-Api-Key", "<X-Api-Key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://api.langparse.dev/api/routers"

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

  req.Header.Add("X-Api-Key", "<X-Api-Key>")

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

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

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

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.langparse.dev/api/routers"))
    .header("X-Api-Key", "<X-Api-Key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.langparse.dev/api/routers")
  .get()
  .addHeader("X-Api-Key", "<X-Api-Key>")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.langparse.dev/api/routers',
  headers: {'X-Api-Key': '<X-Api-Key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.langparse.dev/api/routers';
const options = {method: 'GET', headers: {'X-Api-Key': '<X-Api-Key>'}};

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

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.langparse.dev/api/routers")
  .get()
  .addHeader("X-Api-Key", "<X-Api-Key>")
  .build()

val response = client.newCall(request).execute()

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.langparse.dev/api/routers";

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("X-Api-Key", "<X-Api-Key>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url https://api.langparse.dev/api/routers \
  --header 'X-Api-Key: <X-Api-Key>'

List your routers. A router classifies an incoming document to one of its candidate models before parsing (and can split a multi-doc file into per-document parts), so a single source can handle mixed document types.

Authorizations

apiKey
bearerAuth

Responses

200

Your routers.

application/json

object

data

required

Array<object>

A router. Own key id.

object

key

additional properties

any

meta

required

object

pagination

List pagination. Bounded collections return real totals; large (cursor-backed) collections may leave totals null and set cursor.

object

page

integer

pageSize

integer

totalItems

integer

nullable

totalPages

integer

nullable

hasNext

boolean

hasPrevious

boolean

cursor

string

nullable

Example

[
  {
    "id": "rtr_ap01",
    "name": "Accounts Payable",
    "enabled": true,
    "candidates": [
      {
        "modelId": "mdl_inv01",
        "name": "Invoice",
        "keywords": [
          "invoice",
          "tax"
        ]
      }
    ]
  }
]

401

Missing or invalid API key.

application/json

Error response. statusCode mirrors the HTTP status; statusMessage is human-readable.

object

statusCode

integer

statusMessage

string

Example

{
  "statusCode": 404,
  "statusMessage": "Document not found"
}