Edit a region - Arcade API

POST

/

patterns

/

refine

/

editRegion

Edit a region

curl --request POST \
  --url https://platform.arcade.ai/v1/patterns/refine/editRegion \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "patternId": "<string>",
  "instruction": "<string>",
  "mask": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    requestId: '<string>',
    patternId: '<string>',
    instruction: '<string>',
    mask: '<string>'
  })
};

fetch('https://platform.arcade.ai/v1/patterns/refine/editRegion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://platform.arcade.ai/v1/patterns/refine/editRegion"

payload = {
    "requestId": "<string>",
    "patternId": "<string>",
    "instruction": "<string>",
    "mask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "jobId": "<string>",
  "kind": "pattern",
  "status": "running",
  "result": {
    "patternId": "<string>"
  },
  "error": {
    "message": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

An API key from Settings → API keys in Arcade Studio.

Body

application/json

requestId

string

required

Caller-chosen idempotency key; a replay returns the original result

Required string length: 1 - 128

patternId

string

required

The pattern to refine

Minimum string length: 1

instruction

string

required

Required string length: 1 - 1000

mask

string

required

PNG data URL with the source revision's aspect ratio (the short side may differ by 1 pixel) and a long edge of at most 1536 pixels; it is scaled to the image the edit runs on. Pixels with alpha above 0 are editable, and the selection must cover at least 16 x 16 pixels at that size.

Minimum string length: 1

Response

200 - application/json

OK

jobId

string

required

Opaque job ID; read the job with jobs.get

Minimum string length: 1

kind

enum<string>

required

What the job makes: a pattern (patterns.create or a refine), a product (products.create) or a download (an upscale started in Arcade Studio)

Available options:

pattern,

product,

download

status

enum<string>

required

Jobs are created running; there is no queued state

Available options:

running,

succeeded,

failed

result

object

required

What a succeeded job made. Null while running, when it failed, when a deformity fix found nothing to repair, and once the pattern it made is deleted.

Option 1
Option 2
Option 3

Show child attributes

error

object | null

required

Why the job failed; set once it failed

Show child attributes

createdAt

string<date-time>

required

When the job started; for a product with no recorded build (made by Create, or built before builds were kept), when the product was created

completedAt

string<date-time> | null

required

When the job finished; null while running and for a failed product job, which does not record it

Edit a region

curl --request POST \
  --url https://platform.arcade.ai/v1/patterns/refine/editRegion \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "requestId": "<string>",
  "patternId": "<string>",
  "instruction": "<string>",
  "mask": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    requestId: '<string>',
    patternId: '<string>',
    instruction: '<string>',
    mask: '<string>'
  })
};

fetch('https://platform.arcade.ai/v1/patterns/refine/editRegion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://platform.arcade.ai/v1/patterns/refine/editRegion"

payload = {
    "requestId": "<string>",
    "patternId": "<string>",
    "instruction": "<string>",
    "mask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "jobId": "<string>",
  "kind": "pattern",
  "status": "running",
  "result": {
    "patternId": "<string>"
  },
  "error": {
    "message": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}