Confirm a Pixel card

POST

/v1/pixel/apply

curl --request POST \
  --url https://api.pixonaut.app/v1/pixel/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cardId": "toolu_01A2b3C4d5E6f7G8h9I0j1K2", "conversationId": "pcv_5f0c2a9e1b7d4c3a8e6f0b12" }'

Operation ID: pixelApplications.create

Applies an open card of the caller’s conversation, as the member it belongs to: a studio member’s, or one a member holds in a connected store, through their member key.

Authorizations

• memberKey

Request Body^required

Media typeapplication/json

object

cardId

required

string

>= 1 characters <= 128 characters

conversationId

required

string

/^pcv_[0-9a-f]{24}$/

dontAskAgain

Don’t ask again, on a card that spends credits: turns “Confirm before spending credits” off, so later spends are applied without a card. Refused for any other card, which always asks.

boolean

Examples

Exampleexample

Example

{
  "cardId": "toolu_01A2b3C4d5E6f7G8h9I0j1K2",
  "conversationId": "pcv_5f0c2a9e1b7d4c3a8e6f0b12"
}

Responses

200

The card was applied

Media typeapplication/json

object

conversation

required

object

cards

required

object

key

additional properties

object

change

object

added

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

changed

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

removed

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

restyled

required

boolean

current

object

name

string

names

Array<string>

estimate

object

availableCredits

required

number

credits

required

number

input

pictures

Array<object>

object

assetId

required

string

heightPx

required

number

letteringUnreliable

required

boolean

widthPx

required

number

refusedWith

string

runId

string

savedRevisions

object

key

additional properties

number

showcases

Array<object>

object

baseId

required

string

before

required

Array<object>

<= 50 items

object

id

required

string

/^[A-Za-z0-9_-]{1,40}$/

name

required

string

>= 1 characters <= 60 characters

values

required

object

key

additional properties

object

key

additional properties

name

required

string

status

required

string

tool

required

string

upscaleId

string

contentKeys

required

object

key

additional properties

string

id

required

string

messages

required

Array

Any of:

object

object

content

required

Any of:

string

string

>= 1 characters

Array

Array

>= 1 items

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

assetId

required

string

type

required

string

Allowed values: attachment

object

object

type

required

string

Allowed values: upload

uploadId

required

string

object

object

content

required

Any of:

string

string

Array

Array

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

of

required

One of:

object

object

id

required

string

>= 1 characters <= 200 characters /^[a-z0-9-]+(@\d+)?$/

kind

required

string

Allowed values: template

object

object

id

required

string

>= 1 characters <= 200 characters

kind

required

string

Allowed values: design

revision

required

integer

> 0

object

object

id

required

string

kind

required

string

Allowed values: asset

object

object

id

required

string

kind

required

string

Allowed values: upload

object

object

id

required

string

>= 1 characters <= 200 characters /^[a-z0-9-]+(@\d+)?$/

kind

required

string

Allowed values: trial

values

required

object

key

additional properties

object

key

additional properties

object

object

blankId

required

string

>= 1 characters <= 200 characters

id

required

string

>= 1 characters <= 200 characters /^([a-z0-9-]+)@(\d+)$/

kind

required

string

Allowed values: template_mockup

mockupId

string

>= 1 characters <= 200 characters

placementId

required

string

>= 1 characters <= 200 characters

viewId

string

>= 1 characters <= 200 characters

object

object

id

required

string

>= 1 characters <= 200 characters

kind

required

string

Allowed values: design_mockup

mockupId

string

>= 1 characters <= 200 characters

placementId

string

>= 1 characters <= 200 characters

viewId

string

>= 1 characters <= 200 characters

type

required

string

Allowed values: picture

is_error

boolean

tool_use_id

required

string

>= 1 characters

type

required

string

Allowed values: tool_result

role

required

string

Allowed values: user

object

object

content

required

Array

>= 1 items

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

id

required

string

>= 1 characters

input

name

required

string

>= 1 characters

type

required

string

Allowed values: tool_use

object

object

id

required

string

>= 1 characters

input

name

required

string

type

required

string

Allowed values: server_tool_use

object

object

content

required

One of:

object

object

tool_references

required

Array<object>

object

tool_name

required

string

>= 1 characters

type

required

string

type

required

string

Allowed values: tool_search_tool_search_result

object

object

error_code

required

string

type

required

string

Allowed values: tool_search_tool_result_error

tool_use_id

required

string

>= 1 characters

type

required

string

Allowed values: tool_search_tool_result

role

required

string

Allowed values: assistant

unavailable

required

Array<string>

unseen

required

Array<string>

uploads

required

object

key

additional properties

object

kind

required

string

name

required

string

upscaled

required

object

key

additional properties

object

assetId

required

string

heightPx

required

number

letteringUnreliable

required

boolean

widthPx

required

number

outcome

required

string

result

status

required

number

Examples

Exampleexample

Example

{
  "conversation": {
    "cards": {
      "toolu_01A2b3C4d5E6f7G8h9I0j1K2": {
        "input": {
          "id": "ink_summer"
        },
        "status": "applied",
        "tool": "delete_ink"
      }
    },
    "contentKeys": {},
    "id": "pcv_5f0c2a9e1b7d4c3a8e6f0b12",
    "messages": [
      {
        "content": "Delete the old Summer ink",
        "role": "user"
      },
      {
        "content": [
          {
            "id": "toolu_01A2b3C4d5E6f7G8h9I0j1K2",
            "input": {
              "id": "ink_summer"
            },
            "name": "delete_ink",
            "type": "tool_use"
          }
        ],
        "role": "assistant"
      },
      {
        "content": "Note from the studio: the author confirmed delete_ink, and it was done. Carry on with what they asked for.",
        "role": "user"
      }
    ],
    "unavailable": [],
    "unseen": [],
    "uploads": {},
    "upscaled": {}
  },
  "outcome": "applied",
  "result": null,
  "status": 204
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

400

Refused: invalid_input, invalid_body

Media typeapplication/json

object

error

required

string

Examples

invalid_body

{
  "error": "invalid_body"
}

invalid_input

{
  "error": "invalid_input"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

401

Refused: unauthorized, member_link_required, member_link_revoked

Media typeapplication/json

object

error

required

string

Examples

member_link_required

{
  "error": "member_link_required"
}

member_link_revoked

{
  "error": "member_link_revoked"
}

unauthorized

{
  "error": "unauthorized"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

403

Refused: origin_forbidden, feature_disabled, forbidden, workspace_suspended

Media typeapplication/json

object

error

required

string

feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

forbidden

{
  "error": "forbidden"
}

origin_forbidden

{
  "error": "origin_forbidden"
}

workspace_suspended

{
  "error": "workspace_suspended"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

409

The card was stale: what it would change moved since. Refused: turn_in_progress, conversation_moved, card_not_open

Media typeapplication/json

Any of:

object

object

conversation

required

object

cards

required

object

key

additional properties

object

change

object

added

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

changed

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

removed

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

restyled

required

boolean

current

object

name

string

names

Array<string>

estimate

object

availableCredits

required

number

credits

required

number

input

pictures

Array<object>

object

assetId

required

string

heightPx

required

number

letteringUnreliable

required

boolean

widthPx

required

number

refusedWith

string

runId

string

savedRevisions

object

key

additional properties

number

showcases

Array<object>

object

baseId

required

string

before

required

Array<object>

<= 50 items

object

id

required

string

/^[A-Za-z0-9_-]{1,40}$/

name

required

string

>= 1 characters <= 60 characters

values

required

object

key

additional properties

object

key

additional properties

name

required

string

status

required

string

tool

required

string

upscaleId

string

contentKeys

required

object

key

additional properties

string

id

required

string

messages

required

Array

Any of:

object

object

content

required

Any of:

string

string

>= 1 characters

Array

Array

>= 1 items

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

assetId

required

string

type

required

string

Allowed values: attachment

object

object

type

required

string

Allowed values: upload

uploadId

required

string

object

object

content

required

Any of:

string

string

Array

Array

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

of

required

One of:

object

object

id

required

string

>= 1 characters <= 200 characters /^[a-z0-9-]+(@\d+)?$/

kind

required

string

Allowed values: template

object

object

id

required

string

>= 1 characters <= 200 characters

kind

required

string

Allowed values: design

revision

required

integer

> 0

object

object

id

required

string

kind

required

string

Allowed values: asset

object

object

id

required

string

kind

required

string

Allowed values: upload

object

object

id

required

string

>= 1 characters <= 200 characters /^[a-z0-9-]+(@\d+)?$/

kind

required

string

Allowed values: trial

values

required

object

key

additional properties

object

key

additional properties

object

object

blankId

required

string

>= 1 characters <= 200 characters

id

required

string

>= 1 characters <= 200 characters /^([a-z0-9-]+)@(\d+)$/

kind

required

string

Allowed values: template_mockup

mockupId

string

>= 1 characters <= 200 characters

placementId

required

string

>= 1 characters <= 200 characters

viewId

string

>= 1 characters <= 200 characters

object

object

id

required

string

>= 1 characters <= 200 characters

kind

required

string

Allowed values: design_mockup

mockupId

string

>= 1 characters <= 200 characters

placementId

string

>= 1 characters <= 200 characters

viewId

string

>= 1 characters <= 200 characters

type

required

string

Allowed values: picture

is_error

boolean

tool_use_id

required

string

>= 1 characters

type

required

string

Allowed values: tool_result

role

required

string

Allowed values: user

object

object

content

required

Array

>= 1 items

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

id

required

string

>= 1 characters

input

name

required

string

>= 1 characters

type

required

string

Allowed values: tool_use

object

object

id

required

string

>= 1 characters

input

name

required

string

type

required

string

Allowed values: server_tool_use

object

object

content

required

One of:

object

object

tool_references

required

Array<object>

object

tool_name

required

string

>= 1 characters

type

required

string

type

required

string

Allowed values: tool_search_tool_search_result

object

object

error_code

required

string

type

required

string

Allowed values: tool_search_tool_result_error

tool_use_id

required

string

>= 1 characters

type

required

string

Allowed values: tool_search_tool_result

role

required

string

Allowed values: assistant

unavailable

required

Array<string>

unseen

required

Array<string>

uploads

required

object

key

additional properties

object

kind

required

string

name

required

string

upscaled

required

object

key

additional properties

object

assetId

required

string

heightPx

required

number

letteringUnreliable

required

boolean

widthPx

required

number

outcome

required

string

result

status

required

number

object

object

error

required

string

Examples

card_not_open

{
  "error": "card_not_open"
}

conversation_moved

{
  "error": "conversation_moved"
}

turn_in_progress

{
  "error": "turn_in_progress"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

422

The confirming route refused the card. Refused: payload_too_large

Media typeapplication/json

Any of:

object

object

conversation

required

object

cards

required

object

key

additional properties

object

change

object

added

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

changed

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

removed

required

Array<object>

object

label

required

string

renamedTo

string

text

string

type

required

string

restyled

required

boolean

current

object

name

string

names

Array<string>

estimate

object

availableCredits

required

number

credits

required

number

input

pictures

Array<object>

object

assetId

required

string

heightPx

required

number

letteringUnreliable

required

boolean

widthPx

required

number

refusedWith

string

runId

string

savedRevisions

object

key

additional properties

number

showcases

Array<object>

object

baseId

required

string

before

required

Array<object>

<= 50 items

object

id

required

string

/^[A-Za-z0-9_-]{1,40}$/

name

required

string

>= 1 characters <= 60 characters

values

required

object

key

additional properties

object

key

additional properties

name

required

string

status

required

string

tool

required

string

upscaleId

string

contentKeys

required

object

key

additional properties

string

id

required

string

messages

required

Array

Any of:

object

object

content

required

Any of:

string

string

>= 1 characters

Array

Array

>= 1 items

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

assetId

required

string

type

required

string

Allowed values: attachment

object

object

type

required

string

Allowed values: upload

uploadId

required

string

object

object

content

required

Any of:

string

string

Array

Array

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

of

required

One of:

object

object

id

required

string

>= 1 characters <= 200 characters /^[a-z0-9-]+(@\d+)?$/

kind

required

string

Allowed values: template

object

object

id

required

string

>= 1 characters <= 200 characters

kind

required

string

Allowed values: design

revision

required

integer

> 0

object

object

id

required

string

kind

required

string

Allowed values: asset

object

object

id

required

string

kind

required

string

Allowed values: upload

object

object

id

required

string

>= 1 characters <= 200 characters /^[a-z0-9-]+(@\d+)?$/

kind

required

string

Allowed values: trial

values

required

object

key

additional properties

object

key

additional properties

object

object

blankId

required

string

>= 1 characters <= 200 characters

id

required

string

>= 1 characters <= 200 characters /^([a-z0-9-]+)@(\d+)$/

kind

required

string

Allowed values: template_mockup

mockupId

string

>= 1 characters <= 200 characters

placementId

required

string

>= 1 characters <= 200 characters

viewId

string

>= 1 characters <= 200 characters

object

object

id

required

string

>= 1 characters <= 200 characters

kind

required

string

Allowed values: design_mockup

mockupId

string

>= 1 characters <= 200 characters

placementId

string

>= 1 characters <= 200 characters

viewId

string

>= 1 characters <= 200 characters

type

required

string

Allowed values: picture

is_error

boolean

tool_use_id

required

string

>= 1 characters

type

required

string

Allowed values: tool_result

role

required

string

Allowed values: user

object

object

content

required

Array

>= 1 items

Any of:

object

object

text

required

string

type

required

string

Allowed values: text

object

object

id

required

string

>= 1 characters

input

name

required

string

>= 1 characters

type

required

string

Allowed values: tool_use

object

object

id

required

string

>= 1 characters

input

name

required

string

type

required

string

Allowed values: server_tool_use

object

object

content

required

One of:

object

object

tool_references

required

Array<object>

object

tool_name

required

string

>= 1 characters

type

required

string

type

required

string

Allowed values: tool_search_tool_search_result

object

object

error_code

required

string

type

required

string

Allowed values: tool_search_tool_result_error

tool_use_id

required

string

>= 1 characters

type

required

string

Allowed values: tool_search_tool_result

role

required

string

Allowed values: assistant

unavailable

required

Array<string>

unseen

required

Array<string>

uploads

required

object

key

additional properties

object

kind

required

string

name

required

string

upscaled

required

object

key

additional properties

object

assetId

required

string

heightPx

required

number

letteringUnreliable

required

boolean

widthPx

required

number

outcome

required

string

result

status

required

number

object

object

bytes

number

error

required

string

maxBytes

Always sent with payload_too_large.

number

Examples

Examplepayload_too_large

payload_too_large

{
  "error": "payload_too_large",
  "maxBytes": 0
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

429

Refused: rate_limited

Media typeapplication/json

object

error

required

string

Examples

Examplerate_limited

rate_limited

{
  "error": "rate_limited"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

500

Refused: db_error. A request that failed unexpectedly answers as text instead.

object

error

required

string

Examples

Exampledb_error

db_error

{
  "error": "db_error"
}

string

Allowed value: Internal Server Error

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

503

Refused: apply_failed

Media typeapplication/json

object

error

required

string

Examples

Exampleapply_failed

apply_failed

{
  "error": "apply_failed"
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.