List the models you can shoot with

GET

/models

curl --request GET \
  --url https://api.shootika.com/v1/models \
  --header 'Authorization: Bearer <token>'

Lists the on-model people Shootika can cast in your store, with the poses each one can take. Use a model’s id and one of its poses with a style from GET /styles to request a scene. The list is not paged.

Authorizations

• bearerAuth

Responses

200

The models.

Media typeapplication/json

object

models

required

Array<object>

object

id

required

string format: uuid

name

required

string

is_custom

required

boolean

gender_presentation

required

string

body_type

required

string

skin_tone

required

From 1 (very light) to 6 (dark); 0 when not specified.

integer

poses

required

The poses this model can take. Pass one as pose to POST /scenes.

Array<string>

image

required

Any of:

object

object

webp

required

string format: uri

jpg

required

string format: uri

null

null

Example^generated

{
  "models": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "is_custom": true,
      "gender_presentation": "example",
      "body_type": "example",
      "skin_tone": 1,
      "poses": [
        "example"
      ],
      "image": {
        "webp": "https://example.com",
        "jpg": "https://example.com"
      }
    }
  ]
}

400

bad_request: the request could not be read, for example a multipart body with no boundary.

Media typeapplication/json

object

error

required

What went wrong. Read code in your software; message is for people.

object

code

required

string

Allowed values: api_not_enabled approval_unavailable attach_conflict bad_request catalog_managed_by_shopify conflict daily_cap_reached external_id_taken family_unsupported forbidden idempotency_conflict idempotency_in_progress image_locked internal_error invalid_url media_processing_failed method_not_allowed not_an_image not_found not_ready payment_required quota_exceeded rate_limited result_purged scene_failed scene_generating scene_unsupported service_busy source_image_too_small store_uninstalled too_large unauthorized unreachable_url upload_failed validation_error

message

required

A plain sentence for a person.

string

details

Only present for some codes. For validation_error it maps each wrong field to a list of problems. For quota_exceeded and daily_cap_reached it describes the allowance.

object

key

additional properties

any

Example

{
  "error": {
    "code": "api_not_enabled"
  }
}

401

unauthorized: the Authorization header is missing, or the key is not valid or has been revoked.

Media typeapplication/json

object

error

required

What went wrong. Read code in your software; message is for people.

object

code

required

string

Allowed values: api_not_enabled approval_unavailable attach_conflict bad_request catalog_managed_by_shopify conflict daily_cap_reached external_id_taken family_unsupported forbidden idempotency_conflict idempotency_in_progress image_locked internal_error invalid_url media_processing_failed method_not_allowed not_an_image not_found not_ready payment_required quota_exceeded rate_limited result_purged scene_failed scene_generating scene_unsupported service_busy source_image_too_small store_uninstalled too_large unauthorized unreachable_url upload_failed validation_error

message

required

A plain sentence for a person.

string

details

Only present for some codes. For validation_error it maps each wrong field to a list of problems. For quota_exceeded and daily_cap_reached it describes the allowance.

object

key

additional properties

any

Example

{
  "error": {
    "code": "api_not_enabled"
  }
}

403

api_not_enabled when the API is not switched on for your store yet, store_uninstalled when the store has uninstalled Shootika, or forbidden when the key is not allowed to do that.

Media typeapplication/json

object

error

required

What went wrong. Read code in your software; message is for people.

object

code

required

string

Allowed values: api_not_enabled approval_unavailable attach_conflict bad_request catalog_managed_by_shopify conflict daily_cap_reached external_id_taken family_unsupported forbidden idempotency_conflict idempotency_in_progress image_locked internal_error invalid_url media_processing_failed method_not_allowed not_an_image not_found not_ready payment_required quota_exceeded rate_limited result_purged scene_failed scene_generating scene_unsupported service_busy source_image_too_small store_uninstalled too_large unauthorized unreachable_url upload_failed validation_error

message

required

A plain sentence for a person.

string

details

Only present for some codes. For validation_error it maps each wrong field to a list of problems. For quota_exceeded and daily_cap_reached it describes the allowance.

object

key

additional properties

any

Example

{
  "error": {
    "code": "api_not_enabled"
  }
}

405

method_not_allowed: this address does not accept that method. The Allow header lists the ones it does.

Media typeapplication/json

object

error

required

What went wrong. Read code in your software; message is for people.

object

code

required

string

Allowed values: api_not_enabled approval_unavailable attach_conflict bad_request catalog_managed_by_shopify conflict daily_cap_reached external_id_taken family_unsupported forbidden idempotency_conflict idempotency_in_progress image_locked internal_error invalid_url media_processing_failed method_not_allowed not_an_image not_found not_ready payment_required quota_exceeded rate_limited result_purged scene_failed scene_generating scene_unsupported service_busy source_image_too_small store_uninstalled too_large unauthorized unreachable_url upload_failed validation_error

message

required

A plain sentence for a person.

string

details

Only present for some codes. For validation_error it maps each wrong field to a list of problems. For quota_exceeded and daily_cap_reached it describes the allowance.

object

key

additional properties

any

Example

{
  "error": {
    "code": "api_not_enabled"
  }
}

Headers

Allow

string

429

rate_limited: more than 120 requests in a minute with this key. Wait the number of seconds in Retry-After.

Media typeapplication/json

object

error

required

What went wrong. Read code in your software; message is for people.

object

code

required

string

Allowed values: api_not_enabled approval_unavailable attach_conflict bad_request catalog_managed_by_shopify conflict daily_cap_reached external_id_taken family_unsupported forbidden idempotency_conflict idempotency_in_progress image_locked internal_error invalid_url media_processing_failed method_not_allowed not_an_image not_found not_ready payment_required quota_exceeded rate_limited result_purged scene_failed scene_generating scene_unsupported service_busy source_image_too_small store_uninstalled too_large unauthorized unreachable_url upload_failed validation_error

message

required

A plain sentence for a person.

string

details

Only present for some codes. For validation_error it maps each wrong field to a list of problems. For quota_exceeded and daily_cap_reached it describes the allowance.

object

key

additional properties

any

Example

{
  "error": {
    "code": "api_not_enabled"
  }
}

Headers

Retry-After

integer

500

internal_error: something went wrong on our side. Try again.

Media typeapplication/json

object

error

required

What went wrong. Read code in your software; message is for people.

object

code

required

string

Allowed values: api_not_enabled approval_unavailable attach_conflict bad_request catalog_managed_by_shopify conflict daily_cap_reached external_id_taken family_unsupported forbidden idempotency_conflict idempotency_in_progress image_locked internal_error invalid_url media_processing_failed method_not_allowed not_an_image not_found not_ready payment_required quota_exceeded rate_limited result_purged scene_failed scene_generating scene_unsupported service_busy source_image_too_small store_uninstalled too_large unauthorized unreachable_url upload_failed validation_error

message

required

A plain sentence for a person.

string

details

Only present for some codes. For validation_error it maps each wrong field to a list of problems. For quota_exceeded and daily_cap_reached it describes the allowance.

object

key

additional properties

any

Example

{
  "error": {
    "code": "api_not_enabled"
  }
}

503

service_busy: Shootika is busy right now. Try again in a moment.

Media typeapplication/json

object

error

required

What went wrong. Read code in your software; message is for people.

object

code

required

string

Allowed values: api_not_enabled approval_unavailable attach_conflict bad_request catalog_managed_by_shopify conflict daily_cap_reached external_id_taken family_unsupported forbidden idempotency_conflict idempotency_in_progress image_locked internal_error invalid_url media_processing_failed method_not_allowed not_an_image not_found not_ready payment_required quota_exceeded rate_limited result_purged scene_failed scene_generating scene_unsupported service_busy source_image_too_small store_uninstalled too_large unauthorized unreachable_url upload_failed validation_error

message

required

A plain sentence for a person.

string

details

Only present for some codes. For validation_error it maps each wrong field to a list of problems. For quota_exceeded and daily_cap_reached it describes the allowance.

object

key

additional properties

any

Example

{
  "error": {
    "code": "api_not_enabled"
  }
}

Headers

Retry-After

integer