sites

Insérer une image dans un champ image

Ajoute une image dans un champ image des informations de l'entreprise ou d'une entrée, avec son texte alternatif, dans UNE entrée d'historique, puis lance le build. L'image peut être un fichier des médias du site (media_path), un résultat libre de droits que vous avez choisi (stock_id) ou une description recherchée dans la bibliothèque d'images libres de droits (query, le premier résultat est importé avec son attribution). Gratuit : les images libres de droits ne coûtent aucun crédit.

POST/v1/sites/{site_id}/images:place

Request

curl --request POST \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/images:place' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "target": "<string>",
  "alt": "<string>"
}'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/images:place"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"target\":\"<string>\",\"alt\":\"<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>/images:place", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "target": "<string>",
    "alt": "<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>/images:place");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"target\":\"<string>\",\"alt\":\"<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>/images:place", bytes.NewBuffer([]byte("{\"target\":\"<string>\",\"alt\":\"<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>/images:place"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"target\":\"<string>\",\"alt\":\"<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>/images:place")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"target\":\"<string>\",\"alt\":\"<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": {
    "target": "<string>",
    "image": "<string>",
    "alt": "<string>",
    "alt_field": null,
    "credit": null,
    "revision": "<string>",
    "changed": true,
    "build": {
      "id": "<string>",
      "state": "<string>",
      "next_action": "<string>"
    },
    "next_action": "<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>"
}

Nécessite sites:write. Aucun crédit n’est débité. Le chemin se termine par /images:place. Seul le brouillon est modifié. Les visiteurs ne verront rien tant que vous n’aurez pas publié.

Un seul appel pour « insérer une photo ici ». target désigne le champ image : business:/hero/image pour l’image de la page d’accueil, ou <collection>/<slug>:/image pour une entrée, par exemple services/sourdough:/image. Le modèle de contenu répertorie les champs image.

Indiquez une seule source, exactement :

query : une description en anglais, formulée avec des termes précis. La banque d’images gratuite est consultée et le premier résultat est importé avec son crédit. orientation permet de préciser le format.
stock_id : un résultat que vous avez choisi avec Rechercher dans les banques d’images.
media_path : un fichier déjà présent dans les fichiers multimédias du site, par exemple une photo du propriétaire.

Si le contenu comprend un champ de texte alternatif, alt est enregistré dans ce champ à côté de l’image (par exemple imageAlt) ainsi qu’avec le fichier multimédia. La modification crée une seule entrée dans l’historique et lance la compilation : la réponse contient build. Si la recherche ne trouve rien, elle renvoie 404 et aucune donnée n’est écrite.

Autorisations

Authorizationbearerin headerrequired

Paramètres de chemin

site_idstringrequired

L’identifiant du site ou son slug (l’adresse avant .atelier201.page).

Corps

application/jsonrequired

targetstringrequiredlength: 3–200 chars

Le champ image : business:/hero/image pour les informations de l’entreprise, ou /:/image pour une entrée (services/sourdough:/image). get_content_model indique les champs image.

altstringrequiredlength: 1–300 chars

Description de l’image pour les personnes qui ne peuvent pas la voir, dans la langue du site. Elle est enregistrée dans le champ alt, à côté de l’image, lorsqu’il existe.

querystringlength: ≤ 100 chars

Description à rechercher dans la bibliothèque d’images libres de droits, en anglais et avec des termes concrets ("minimalist concrete house at dusk") : le premier résultat est importé.

stock_idstringlength: ≤ 20 chars

ID d’un résultat de search_stock_media, si vous avez choisi l’image vous-même.

media_pathstringlength: ≤ 200 chars

Fichier déjà présent dans les médias du site (/media/storefront.jpg), par exemple une photo du propriétaire.

orientationenum<string>one of: landscape, portrait, square

Avec query : format de l’image à rechercher. Landscape convient à une image hero.

Réponse

application/json

Ajouter une image dans un champ image

dataRecord<string, object>required

Show child attributes

data.targetstringrequired

data.imagestringrequired

Le chemin /media actuellement présent dans le champ.

data.altstringrequired

data.alt_fieldstringnullrequired

L'emplacement où le texte alternatif a été enregistré, ou null si le contenu ne comporte pas de champ alt.

data.creditstringnullrequired

data.revisionstringrequiredlength: 40–40 chars

Un identifiant de commit Git (40 caractères hexadécimaux) du dépôt du site.

data.changedbooleanrequired

data.buildobject | nullrequired

La génération démarrée (ou rejointe) par cette modification : l’aperçu la suit. Aucun appel à build_site n’est nécessaire.

Show child attributes

data.build.idstringrequired

data.build.statestringrequired

data.build.next_actionstringrequired

data.next_actionstringrequired

request_idstringrequired

curl --request POST \ --url 'https://api.atelier201.com/v1/sites/<site_id>/images:place' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "target": "<string>", "alt": "<string>" }'

{ "data": { "target": "<string>", "image": "<string>", "alt": "<string>", "alt_field": null, "credit": null, "revision": "<string>", "changed": true, "build": { "id": "<string>", "state": "<string>", "next_action": "<string>" }, "next_action": "<string>" }, "request_id": "<string>" }

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

Insérer une image dans un champ image

Autorisations

Paramètres de chemin

Corps

Réponse

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies