files

Pesquisar nos arquivos de um site

Linhas que correspondem a uma expressão regular (no estilo do ripgrep; regex=false para texto simples) nos arquivos de texto do projeto. A pesquisa não diferencia maiúsculas de minúsculas por padrão. glob e under restringem os arquivos, context adiciona linhas ao redor de cada correspondência e output=files lista somente os arquivos correspondentes. Há um limite de 100 resultados; truncated indica quando existem mais.

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

Requer sites:read.

Quando truncated for true, restrinja a busca com under ou use uma consulta mais específica.

Autorizações

Authorizationbearerin headerrequired

Parâmetros de caminho

site_idstringrequired

O id do site ou seu slug (o endereço antes de .atelier201.page).

Parâmetros de consulta

querystringrequiredlength: 1–500 chars

Uma expressão regular (no estilo do ripgrep) ou texto simples com regex=false.

regexboolean

O padrão é true. false pesquisa o texto literalmente.

case_sensitiveboolean

O padrão é false.

understringlength: ≤ 300 chars

Pesquisar somente nesta pasta.

globstringlength: ≤ 200 chars

Pesquisar somente arquivos que correspondam a este glob, por exemplo, .astro ou src/**/.css.

contextintegerrange: 0–5

Linhas de contexto antes e depois de cada correspondência (como grep -C). O padrão é 0.

outputenum<string>one of: lines, files

lines (padrão): cada linha correspondente. files: somente os arquivos correspondentes, com o número de linhas correspondentes em cada um.

limitintegerrange: 1–100

revisionstringlength: 40–40 chars

Um ID de commit do Git (40 caracteres hexadecimais) do repositório do site.

Resposta

application/json

Pesquisar nos arquivos de um 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[]

Com contexto: as linhas anteriores, da mais antiga para a mais recente.

data.results.afterstring[]

Com contexto: as linhas posteriores.

data.filesobject[]

Com output=files: os arquivos correspondentes.

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

Pesquisar nos arquivos de um site

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies