files

Buscar en los archivos de un sitio

Líneas que coinciden con una expresión regular (al estilo de ripgrep) en los archivos de texto del proyecto. La búsqueda no distingue entre mayúsculas y minúsculas de forma predeterminada (regex=false para buscar texto literal). glob y under restringen los archivos, context añade líneas alrededor de cada coincidencia y output=files muestra solo los archivos coincidentes. Límite: 100 resultados como máximo. truncated indica si hay más.

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

Requiere sites:read.

Si truncated es true, limita la búsqueda con under o una consulta más específica.

Autorizaciones

Authorizationbearerin headerrequired

Parámetros de ruta

site_idstringrequired

El ID del sitio o su slug (la dirección antes de .atelier201.page).

Parámetros de consulta

querystringrequiredlength: 1–500 chars

Una expresión regular (al estilo de ripgrep) o texto literal con regex=false.

regexboolean

Valor predeterminado: true. false busca el texto de forma literal.

case_sensitiveboolean

Valor predeterminado: false.

understringlength: ≤ 300 chars

Buscar solo dentro de esta carpeta.

globstringlength: ≤ 200 chars

Buscar solo en los archivos que coincidan con este patrón glob, por ejemplo, .astro o src/**/.css.

contextintegerrange: 0–5

Número de líneas de contexto antes y después de cada coincidencia (como grep -C). Valor predeterminado: 0.

outputenum<string>one of: lines, files

lines (valor predeterminado): cada línea coincidente. files: solo los archivos coincidentes, con el número de líneas coincidentes de cada uno.

limitintegerrange: 1–100

revisionstringlength: 40–40 chars

Un ID de commit de Git (40 caracteres hexadecimales) del repositorio del sitio.

Respuesta

application/json

Buscar en los archivos de un sitio

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[]

Con contexto: las líneas anteriores, de la más antigua a la más reciente.

data.results.afterstring[]

Con contexto: las líneas posteriores.

data.filesobject[]

Con output=files: los archivos coincidentes.

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

Buscar en los archivos de un sitio

Autorizaciones

Parámetros de ruta

Parámetros de consulta

Respuesta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies