sites

Colocar una imagen en un campo de imagen

Añade una imagen a un campo de imagen de los datos de la empresa o de una entrada, junto con su texto alternativo, en UNA sola entrada del historial, e inicia la compilación. La imagen puede ser un archivo de los archivos multimedia del sitio (media_path), un resultado de stock que hayas elegido (stock_id) o una descripción buscada en la biblioteca de stock gratuita (query; se importa el primer resultado junto con su atribución). Gratis: las imágenes de stock no consumen créditos.

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

Requiere sites:write. No cuesta créditos. La ruta termina en /images:place. Solo modifica el borrador. Los visitantes no verán ningún cambio hasta que publiques.

Una sola llamada para «coloca aquí una foto». target es el campo de imagen: business:/hero/image para la imagen de la página de inicio, o <collection>/<slug>:/image para una entrada, como services/sourdough:/image. El modelo de contenido enumera los campos de imagen.

Indica exactamente una fuente:

query: una descripción en inglés con términos concretos. Se busca en la biblioteca gratuita de imágenes de archivo y se importa el primer resultado con su atribución. orientation permite filtrar por formato.
stock_id: un resultado que hayas elegido con Buscar imágenes de archivo.
media_path: un archivo que ya esté en los archivos multimedia del sitio, como una foto del propietario.

Si el contenido tiene un campo de texto alternativo, alt se guarda en ese campo junto a la imagen (por ejemplo, en imageAlt) y también con el archivo multimedia. El cambio se añade como una sola entrada al historial y se inicia la compilación: la respuesta incluye build. Si no se encuentra ningún resultado, se devuelve 404 y no se escribe nada.

Autorizaciones

Authorizationbearerin headerrequired

Parámetros de ruta

site_idstringrequired

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

Cuerpo

application/jsonrequired

targetstringrequiredlength: 3–200 chars

El campo de imagen: business:/hero/image para los datos de la empresa o /:/image para una entrada (services/sourdough:/image). get_content_model muestra los campos de imagen.

altstringrequiredlength: 1–300 chars

Qué muestra la imagen, para las personas que no pueden verla, en el idioma del sitio. Se guarda en el campo alt junto a la imagen, si lo hay.

querystringlength: ≤ 100 chars

Descripción para buscar en la biblioteca de imágenes gratuitas. Escríbela en inglés con términos concretos ("minimalist concrete house at dusk"). Se importa el primer resultado.

stock_idstringlength: ≤ 20 chars

ID de un resultado de search_stock_media, si has elegido la imagen manualmente.

media_pathstringlength: ≤ 200 chars

Archivo que ya está en la carpeta de medios del sitio (/media/storefront.jpg), por ejemplo, una foto del propietario.

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

Con query: la orientación que se debe buscar. El formato apaisado es adecuado para una imagen principal.

Respuesta

application/json

Añadir una imagen a un campo de imagen

dataRecord<string, object>required

Show child attributes

data.targetstringrequired

data.imagestringrequired

La ruta /media que hay ahora en el campo.

data.altstringrequired

data.alt_fieldstringnullrequired

Dónde se ha guardado el texto alternativo, o null si el contenido no tiene un campo de texto alternativo.

data.creditstringnullrequired

data.revisionstringrequiredlength: 40–40 chars

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

data.changedbooleanrequired

data.buildobject | nullrequired

La compilación que inició este cambio (o a la que se incorporó): la vista previa la sigue. No hace falta llamar a build_site.

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

Colocar una imagen en un campo de imagen

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies