files

Search the files of a site

Lines matching a regular expression (ripgrep style; regex=false for plain text) in the project's text files, case-insensitive by default. glob and under narrow the files, context adds lines around each match, output=files lists only the matching files. Bounded: at most 100 results, and truncated says when there are more.

GET/v1/sites/{site_id}/search

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/search?query=<query>' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/search?query=<query>"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/search?query=<query>", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.atelier201.com/v1/sites/<site_id>/search?query=<query>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://api.atelier201.com/v1/sites/<site_id>/search?query=<query>", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.atelier201.com/v1/sites/<site_id>/search?query=<query>"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.atelier201.com/v1/sites/<site_id>/search?query=<query>")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "revision": "<string>",
    "results": [
      {
        "path": "<string>",
        "line": 123,
        "text": "<string>",
        "before": [
          "<string>"
        ],
        "after": [
          "<string>"
        ]
      }
    ],
    "files": [
      {
        "path": "<string>",
        "matches": 123
      }
    ],
    "truncated": true,
    "files_searched": 123
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Requires sites:read.

When truncated is true, narrow the search with under or a more specific query.

Authorizations

Authorizationbearerin headerrequired

Path parameters

site_idstringrequired

The site's id, or its slug (the address before .atelier201.page).

Query parameters

querystringrequiredlength: 1–500 chars

A regular expression (ripgrep style), or plain text with regex=false.

regexboolean

Default true. false searches the text literally.

case_sensitiveboolean

Default false.

understringlength: ≤ 300 chars

Only search under this folder.

globstringlength: ≤ 200 chars

Only search files matching this glob, e.g. .astro or src/**/.css.

contextintegerrange: 0–5

Lines of context before and after each match (like grep -C). Default 0.

outputenum<string>one of: lines, files

lines (default): each matching line. files: only the files that match, with their number of matching lines.

limitintegerrange: 1–100

revisionstringlength: 40–40 chars

A Git commit id (40 hex characters) of the site's repository.

Response

application/json

Search the files of a site

dataobjectrequired

Show child attributes

data.revisionstring | nullrequired

data.resultsobject[]required

Show child attributes

data.results.pathstringrequired

data.results.lineintegerrequiredrange: -9007199254740991–9007199254740991

data.results.textstringrequired

data.results.beforestring[]

With context: the lines before, oldest first.

data.results.afterstring[]

With context: the lines after.

data.filesobject[]

With output=files: the matching files.

Show child attributes

data.files.pathstringrequired

data.files.matchesintegerrequiredrange: -9007199254740991–9007199254740991

data.truncatedbooleanrequired

data.files_searchedintegerrequiredrange: -9007199254740991–9007199254740991

request_idstringrequired

{ "data": { "revision": "<string>", "results": [ { "path": "<string>", "line": 123, "text": "<string>", "before": [ "<string>" ], "after": [ "<string>" ] } ], "files": [ { "path": "<string>", "matches": 123 } ], "truncated": true, "files_searched": 123 }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>", "details": {} }, "request_id": "<string>" }

Search the files of a site

Authorizations

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies