Create an API key (requires admin)

POST

/api/apikeys

CURL *hnd = curl_easy_init();

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

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

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"name\": \"CI pipeline\", \"scopes\": [ \"parse\" ] }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.langparse.dev/api/apikeys"),
    Headers =
    {
        { "X-Api-Key", "<X-Api-Key>" },
    },
    Content = new StringContent("{ \"name\": \"CI pipeline\", \"scopes\": [ \"parse\" ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

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

  payload := strings.NewReader("{ \"name\": \"CI pipeline\", \"scopes\": [ \"parse\" ] }")

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

  req.Header.Add("X-Api-Key", "<X-Api-Key>")
  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))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.langparse.dev/api/apikeys"))
    .header("X-Api-Key", "<X-Api-Key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"name\": \"CI pipeline\", \"scopes\": [ \"parse\" ] }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"name\": \"CI pipeline\", \"scopes\": [ \"parse\" ] }");
Request request = new Request.Builder()
  .url("https://api.langparse.dev/api/apikeys")
  .post(body)
  .addHeader("X-Api-Key", "<X-Api-Key>")
  .addHeader("Content-Type", "application/json")
  .build();

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

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://api.langparse.dev/api/apikeys',
  headers: {'X-Api-Key': '<X-Api-Key>', 'Content-Type': 'application/json'},
  data: {name: 'CI pipeline', scopes: ['parse']}
};

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

const url = 'https://api.langparse.dev/api/apikeys';
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<X-Api-Key>', 'Content-Type': 'application/json'},
  body: '{"name":"CI pipeline","scopes":["parse"]}'
};

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

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"name\": \"CI pipeline\", \"scopes\": [ \"parse\" ] }")
val request = Request.Builder()
  .url("https://api.langparse.dev/api/apikeys")
  .post(body)
  .addHeader("X-Api-Key", "<X-Api-Key>")
  .addHeader("Content-Type", "application/json")
  .build()

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

use serde_json::json;
use reqwest;

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

    let payload = json!({
        "name": "CI pipeline",
        "scopes": ("parse")
    });

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

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

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

    dbg!(results);
}

curl --request POST \
  --url https://api.langparse.dev/api/apikeys \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --data '{ "name": "CI pipeline", "scopes": [ "parse" ] }'

wget --quiet \
  --method POST \
  --header 'X-Api-Key: <X-Api-Key>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "name": "CI pipeline", "scopes": [ "parse" ] }' \
  --output-document \
  - https://api.langparse.dev/api/apikeys

The secret is returned once — store it now. scopes default to ["parse"]; granting manage/admin needs the admin role.

Authorizations

apiKey
bearerAuth

Request Body^required

application/json

object

name

required

string

scopes

Array<string>

Allowed values: parse manage admin

Example

{
  "name": "CI pipeline",
  "scopes": [
    "parse"
  ]
}

Responses

200

The new key — the secret is shown only here.

application/json

object

data

required

object

string

name

string

scopes

Array<string>

secret

string

Example

{
  "data": {
    "id": "key_mrb1a2c3",
    "name": "CI pipeline",
    "scopes": [
      "parse"
    ],
    "secret": "lp_use1_…"
  }
}

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"
}

Create an API key (requires admin)

Authorizations

Request Bodyrequired

Example

Responses

200

Example

401

Example

Request Body^required