sites

Bild in ein Bildfeld einfügen

Fügt ein Bild mit Alternativtext in einem Verlaufseintrag in ein Bildfeld von Unternehmensdetails oder einem Eintrag ein und startet den Build. Das Bild ist eine Datei aus den Medien der Website (media_path), ein von dir ausgewähltes Stock-Ergebnis (stock_id) oder eine Beschreibung, die in der kostenlosen Stock-Bibliothek gesucht wird (query; das erste Ergebnis wird mit Quellenangabe importiert). Kostenlos: Stockbilder kosten keine Credits.

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

Erfordert sites:write. Kostet keine Credits. Der Pfad endet mit /images:place. Es wird nur der Entwurf geändert. Besucher sehen die Änderung erst, wenn Sie veröffentlichen.

Ein Aufruf für „Hier ein Foto einfügen“. target bezeichnet das Bildfeld: business:/hero/image für das Bild auf der Startseite oder <collection>/<slug>:/image für einen Eintrag, zum Beispiel services/sourdough:/image. Die Inhaltsstruktur führt die Bildfelder auf.

Geben Sie genau eine Quelle an:

query: eine Beschreibung auf Englisch mit konkreten Begriffen. Die kostenlose Stock-Bildbibliothek wird durchsucht und das erste Ergebnis samt Quellenangabe importiert. Mit orientation lässt sich das Bildformat eingrenzen.
stock_id: ein Suchergebnis, das Sie über Stock-Medien durchsuchen ausgewählt haben.
media_path: eine Datei, die sich bereits in den Medien der Website befindet, zum Beispiel ein eigenes Foto des Inhabers.

alt wird im Alt-Feld neben dem Bild gespeichert, sofern der Inhalt eines hat (zum Beispiel imageAlt), und auch bei der Mediendatei. Die Änderung bildet einen Verlaufseintrag und der Build startet: Die Antwort enthält build. Ergibt die Suche keinen Treffer, wird 404 zurückgegeben und es werden keine Änderungen vorgenommen.

Autorisierung

Authorizationbearerin headerrequired

Pfadparameter

site_idstringrequired

ID der Website oder ihr Slug (die Adresse vor .atelier201.page).

Body

application/jsonrequired

targetstringrequiredlength: 3–200 chars

Das Bildfeld: business:/hero/image für Unternehmensdetails oder /:/image für einen Eintrag (services/sourdough:/image). get_content_model zeigt die Bildfelder an.

altstringrequiredlength: 1–300 chars

Beschreibt in der Sprache der Website, was auf dem Bild zu sehen ist, für Menschen, die es nicht sehen können. Wird neben dem Bild im Feld alt gespeichert, sofern dieses vorhanden ist.

querystringlength: ≤ 100 chars

Eine Suchbeschreibung für die kostenlose Stock-Bibliothek. Auf Englisch und mit konkreten Begriffen, etwa „minimalist concrete house at dusk“: Das erste Ergebnis wird importiert.

stock_idstringlength: ≤ 20 chars

Eine Ergebnis-ID von search_stock_media, wenn du das Bild selbst ausgewählt hast.

media_pathstringlength: ≤ 200 chars

Eine Datei, die sich bereits in den Medien der Website befindet (/media/storefront.jpg), zum Beispiel ein eigenes Foto des Inhabers.

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

Mit query: das gesuchte Format. Landscape eignet sich für ein Hero-Bild.

Antwort

application/json

Bild in ein Bildfeld einfügen

dataRecord<string, object>required

Show child attributes

data.targetstringrequired

data.imagestringrequired

Der /media-Pfad, der derzeit im Feld steht.

data.altstringrequired

data.alt_fieldstringnullrequired

Gibt an, wo der Alternativtext gespeichert wurde, oder null, wenn der Inhalt kein Alternativtextfeld hat.

data.creditstringnullrequired

data.revisionstringrequiredlength: 40–40 chars

Eine Git-Commit-ID (40 hexadezimale Zeichen) des Repositorys der Website.

data.changedbooleanrequired

data.buildobject | nullrequired

Der Build, den diese Änderung gestartet oder übernommen hat: Die Vorschau folgt diesem Build. Kein Aufruf von build_site erforderlich.

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

Bild in ein Bildfeld einfügen

Autorisierung

Pfadparameter

Body

Antwort

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies