media

Get an AI generation

Running, succeeded (with the media file) or failed (credits given back). wait_seconds (55 at most) waits for it to finish. Kept 7 days.

GET/v1/sites/{site_id}/media/generations/{generation_id}

Request

curl --request GET \
  --url 'https://api.atelier201.com/v1/sites/<site_id>/media/generations/<generation_id>' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.atelier201.com/v1/sites/<site_id>/media/generations/<generation_id>"
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>/media/generations/<generation_id>", {
  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>/media/generations/<generation_id>");
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>/media/generations/<generation_id>", 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>/media/generations/<generation_id>"))
    .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>/media/generations/<generation_id>")
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": {
    "id": "<string>",
    "status": "running",
    "media": {
      "path": "<string>",
      "url_path": "<string>",
      "mime": "<string>",
      "size": 123,
      "alt": null,
      "credit": null,
      "keep_original": true
    },
    "error": null,
    "credits": 123,
    "credits_refunded": 123,
    "estimated_credits": 123,
    "balance": 123.45,
    "next_action": null
  },
  "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>"
}

Requires sites:read. Costs no credits.

status is running, succeeded (with media, its path and type) or failed (with error and credits_refunded: the credits were given back). wait_seconds, 55 at most, waits for it to finish before answering. A generation can be read back for 7 days.

Authorizations

Authorizationbearerin headerrequired

Path parameters

site_idstringrequired

The site's id, or its slug (the address before .atelier201.page).

generation_idstringrequired

Query parameters

wait_secondsintegerrange: 0–55

Response

application/json

Get an AI generation

dataRecord<string, object>required

Show child attributes

data.idstring

The generation's id: GET it until status is succeeded or failed.

data.statusenum<string>one of: running, succeeded, failed

data.mediaobject | null

Show child attributes

data.media.pathstringrequired

data.media.url_pathstringrequired

data.media.mimestringrequired

data.media.sizeintegerrequiredrange: -9007199254740991–9007199254740991

data.media.altstringnullrequired

data.media.creditstringnullrequired

Who made it, where a licence asks for it: "Photo by Jane Doe on Pixabay", "Generated with Seedream 5 Lite (ByteDance)". Null for an upload.

data.media.keep_originalbooleanrequired

Stored exactly as uploaded, and never re-encoded by a build. Otherwise a picture over 200 KB is compressed when it arrives (2000 px at most, towards 150 KB, quality 75 or more, metadata removed).

data.errorstringnull

data.creditsinteger | null

What it cost.

data.credits_refundedinteger | null

Given back after a failure.

data.estimated_creditsintegerrange: -9007199254740991–9007199254740991

estimate_only: the exact price it would cost.

data.balancenumber

estimate_only: the workspace's credits now.

data.next_actionstringnullrequired

request_idstringrequired

{ "data": { "id": "<string>", "status": "running", "media": { "path": "<string>", "url_path": "<string>", "mime": "<string>", "size": 123, "alt": null, "credit": null, "keep_original": true }, "error": null, "credits": 123, "credits_refunded": 123, "estimated_credits": 123, "balance": 123.45, "next_action": null }, "request_id": "<string>" }

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

Get an AI generation

Authorizations

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown

Cookies