curl --request POST \
--url https://app.goosybear.ai/api/v1/tools/images.describe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"board": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generation_id": "<string>",
"page": 2,
"workspace": "<string>"
}
'import requests
url = "https://app.goosybear.ai/api/v1/tools/images.describe"
payload = {
"board": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generation_id": "<string>",
"page": 2,
"workspace": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
board: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
generation_id: '<string>',
page: 2,
workspace: '<string>'
})
};
fetch('https://app.goosybear.ai/api/v1/tools/images.describe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.goosybear.ai/api/v1/tools/images.describe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'board' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'generation_id' => '<string>',
'page' => 2,
'workspace' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.goosybear.ai/api/v1/tools/images.describe"
payload := strings.NewReader("{\n \"board\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generation_id\": \"<string>\",\n \"page\": 2,\n \"workspace\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.goosybear.ai/api/v1/tools/images.describe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"board\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generation_id\": \"<string>\",\n \"page\": 2,\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.goosybear.ai/api/v1/tools/images.describe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"board\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generation_id\": \"<string>\",\n \"page\": 2,\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"workspace": "<string>",
"working_in": {
"label": "<string>",
"note": "<string>",
"workspace": "<string>",
"source": "call-override"
},
"boardId": "<string>",
"page": 2,
"pageSize": 2,
"totalCount": 1,
"hasMore": true,
"images": [
{
"generationId": "<string>",
"role": "<string>",
"status": "<string>",
"description": "<string>",
"createdAt": "<string>"
}
],
"instruction": "<string>",
"generationId": "<string>",
"status": "<string>",
"description": "<string>",
"describedAt": "<string>",
"createdAt": "<string>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}Call images.describe
‘what images are on this board’, ‘tell me more about this image’ — without generation_id, list one board’s images, newest first: each image’s id, stored caption and status; with generation_id, read that one image’s stored description in full. The board is named by id and must be this workspace’s. A listing is one page: totalCount is the board’s real size, hasMore means older images sit on later pages, and page is a direct index, so the oldest images are on page ceil(totalCount / pageSize). It changes nothing. Not for the workspace’s saved photos, logo and product shots — that is images.brand_elements.
Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.
curl --request POST \
--url https://app.goosybear.ai/api/v1/tools/images.describe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"board": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generation_id": "<string>",
"page": 2,
"workspace": "<string>"
}
'import requests
url = "https://app.goosybear.ai/api/v1/tools/images.describe"
payload = {
"board": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"generation_id": "<string>",
"page": 2,
"workspace": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
board: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
generation_id: '<string>',
page: 2,
workspace: '<string>'
})
};
fetch('https://app.goosybear.ai/api/v1/tools/images.describe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.goosybear.ai/api/v1/tools/images.describe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'board' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'generation_id' => '<string>',
'page' => 2,
'workspace' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.goosybear.ai/api/v1/tools/images.describe"
payload := strings.NewReader("{\n \"board\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generation_id\": \"<string>\",\n \"page\": 2,\n \"workspace\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.goosybear.ai/api/v1/tools/images.describe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"board\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generation_id\": \"<string>\",\n \"page\": 2,\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.goosybear.ai/api/v1/tools/images.describe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"board\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"generation_id\": \"<string>\",\n \"page\": 2,\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"workspace": "<string>",
"working_in": {
"label": "<string>",
"note": "<string>",
"workspace": "<string>",
"source": "call-override"
},
"boardId": "<string>",
"page": 2,
"pageSize": 2,
"totalCount": 1,
"hasMore": true,
"images": [
{
"generationId": "<string>",
"role": "<string>",
"status": "<string>",
"description": "<string>",
"createdAt": "<string>"
}
],
"instruction": "<string>",
"generationId": "<string>",
"status": "<string>",
"description": "<string>",
"describedAt": "<string>",
"createdAt": "<string>"
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}Authorizations
An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.
Headers
Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.
128Body
The board to act on, by id — one of this workspace's boards (board.tree lists them).
The id of ONE image to describe in detail. OMIT to list this board's images (ids + prompts + captions) — call it that way FIRST whenever you need an image id for images.iterate / images.add_to_board.
Listing page, a DIRECT INDEX (newest first, 8 per page) — page 1 is the newest and the OLDEST images are on page ceil(totalCount / pageSize), so jump straight to the page you want rather than walking one page at a time. The listing result says totalCount and hasMore. Ignored when generation_id is set.
x >= 1Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.
1Response
The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.
- Option 1
- Option 2
The tool ran and answered.
The slug of the workspace this call ran in.
Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
Show child attributes
Show child attributes
x >= 1x >= 1x >= 0Show child attributes
Show child attributes
1