files

Leggi più file

Fino a 30 file a una revisione (la bozza, a meno che non sia specificato revision), ciascuno con contenuto e hash: tutto ciò che serve per modificare più file in una sola chiamata. Se un file non può essere letto, include error; gli altri vengono comunque restituiti. Non modifica nulla.

POST/v1/sites/{site_id}/files/read

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/files/read' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "paths": [
    "<string>"
  ]
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/files/read"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"paths\":[\"<string>\"]}")

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

const response = await fetch("https://api.atelier201.com/v1/sites/<site_id>/files/read", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "paths": [
      "<string>"
    ]
  }),
});

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>/files/read");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"paths\":[\"<string>\"]}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

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

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://api.atelier201.com/v1/sites/<site_id>/files/read", bytes.NewBuffer([]byte("{\"paths\":[\"<string>\"]}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  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>/files/read"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"paths\":[\"<string>\"]}"))
    .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>/files/read")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"paths\":[\"<string>\"]}"

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>",
    "files": [
      {
        "path": "<string>",
        "hash": "<string>",
        "size": 123,
        "encoding": "utf8",
        "content": "<string>",
        "error": "<string>"
      }
    ]
  },
  "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. Non modifica nulla.

Usalo prima di modificare più file: una sola chiamata restituisce tutti i contenuti e gli hash da inviare come expected_hash. Se un file non può essere letto, viene restituito con error; gli altri vengono comunque inclusi.

Autorizzazioni

Authorizationbearerin headerrequired

Parametri di percorso

site_idstringrequired

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

Corpo

application/jsonrequired

pathsstring[]requireditems: 1–30 items

Fino a 30 file, letti a un'unica revisione.

revisionstringlength: 40–40 chars

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

Risposta

application/json

Leggere più file

dataobjectrequired

Show child attributes

data.revisionstring | nullrequired

data.filesobject[]required

Show child attributes

data.files.pathstringrequired

data.files.hashstring

data.files.sizeintegerrange: -9007199254740991–9007199254740991

data.files.encodingenum<string>one of: utf8, base64

data.files.contentstring

data.files.errorstring

Motivo per cui non è stato possibile leggere questo file (gli altri vengono comunque restituiti).

request_idstringrequired

curl --request POST \ --url 'https://api.atelier201.com/v1/sites/<site_id>/files/read' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "paths": [ "<string>" ] }'

{ "data": { "revision": "<string>", "files": [ { "path": "<string>", "hash": "<string>", "size": 123, "encoding": "utf8", "content": "<string>", "error": "<string>" } ] }, "request_id": "<string>" }

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

Leggi più file

Autorizzazioni

Parametri di percorso

Corpo

Risposta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookie