files

Cerca nei file di un sito

Righe che corrispondono a un'espressione regolare (stile ripgrep; regex=false per testo semplice) nei file di testo del progetto. La ricerca non distingue tra maiuscole e minuscole per impostazione predefinita. glob e under restringono i file, context aggiunge righe intorno a ogni corrispondenza, output=files elenca solo i file corrispondenti. Limite: massimo 100 risultati; truncated indica se ce ne sono altri.

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

Richiede sites:read.

Se truncated è true, restringi la ricerca usando under o una query più specifica.

Autorizzazioni

Authorizationbearerin headerrequired

Parametri di percorso

site_idstringrequired

L'ID del sito o il suo slug (l'indirizzo prima di .atelier201.page).

Parametri di query

querystringrequiredlength: 1–500 chars

Un'espressione regolare (stile ripgrep) oppure testo semplice con regex=false.

regexboolean

Predefinito: true. false cerca il testo alla lettera.

case_sensitiveboolean

Predefinito: false.

understringlength: ≤ 300 chars

Cerca solo in questa cartella.

globstringlength: ≤ 200 chars

Cerca solo nei file che corrispondono a questo glob, ad esempio .astro o src/**/.css.

contextintegerrange: 0–5

Righe di contesto prima e dopo ogni corrispondenza (come grep -C). Predefinito: 0.

outputenum<string>one of: lines, files

lines (predefinito): ogni riga corrispondente. files: solo i file corrispondenti, con il numero di righe corrispondenti.

limitintegerrange: 1–100

revisionstringlength: 40–40 chars

ID di un commit Git (40 caratteri esadecimali) del repository del sito.

Risposta

application/json

Cercare nei file di un sito

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 context: le righe precedenti, dalla più vecchia alla più recente.

data.results.afterstring[]

Con context: le righe successive.

data.filesobject[]

Con output=files: i file corrispondenti.

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

Cerca nei file di un sito

Autorizzazioni

Parametri di percorso

Parametri di query

Risposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookie